diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 4148f5128..28aabe4fa 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -16,4 +16,11 @@ If somebody claims an issue but doesn’t follow up for more than two weeks, it ### Contribution Prerequisites -... 🚧 Work in progress 🚧 ... +Before you start contributing, make sure you have: + +- Rust (>=1.89.0) and Cargo installed +- Node.js (>=v24.4.1) and npm (>=11.5.2) for SDK work +- Git for version control +- A code editor (VSCode recommended for the extension support) + +For more details, see the [README](../README.md#prerequisites). diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 26229dddc..39f64462d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -15,4 +15,6 @@ ### Checklist - [ ] Tests added in this PR (if applicable) - +- [ ] Code builds without errors (`cargo build`) +- [ ] Code formatted with `cargo fmt-stacks` +- [ ] Documentation updated (if applicable) diff --git a/README.md b/README.md index 9809571d7..000366fb7 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,9 @@ brew install clarinet ``` > To check out more installation methods, click -> [here](https://docs.hiro.so/stacks/clarinet#installation) +> [here](https://docs.hiro.so/stacks/clarinet#installation). + +> **Tip:** If you're on Windows or Linux, check the installation docs for platform-specific instructions. ```bash # Create a new project @@ -97,10 +99,10 @@ of Rust and Node.js (LTS) tooling. This repo follows the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/#summary) specification when writing commit messages. -**Note:** These conventions are helpful for any commit message, but all PR end up being merged with -"squash and merge", giving an other chance to refine the commit messages. +**Note:** These conventions are helpful for any commit message, but all PRs end up being merged with +"squash and merge", giving another chance to refine the commit messages. -To start contributing, fork this repo and open a new branc: +To start contributing, fork this repo and open a new branch: 1. Fork this repo and clone the fork locally. 1. Create a new branch @@ -133,7 +135,7 @@ For VSCode users, we recommend opening the following workspace Wasm target. The SDK is divided between the Rust lib compiled to Wasm `./components/clarinet-sdk-wasm` and a TS -wrapper around it: `./components/clarinet-sdk-wasm`. +wrapper around it: `./components/clarinet-sdk`. 1. Compile the Wasm package with `npm run build:sdk-wasm` 1. Compile the SDK with `npm run build:sdk` @@ -143,7 +145,7 @@ Learn more in the [SDK Readme.md](./components/clarinet-sdk/README.md). ### Code of Conduct -Please read our [Code of conduct](../../../.github/blob/main/CODE_OF_CONDUCT.md) since we expect +Please read our [Code of Conduct](.github/CONTRIBUTING.md) since we expect project participants to adhere to it. ## Community diff --git a/codecov.yml b/codecov.yml index 0c5c5e72a..df70b7b77 100644 --- a/codecov.yml +++ b/codecov.yml @@ -1,8 +1,12 @@ +# Codecov configuration for test coverage reporting +# See: https://docs.codecov.com/docs/codecovyml-reference + coverage: status: patch: false project: default: + # Allowed drop in coverage percentage before failing threshold: 5% if_not_found: failure