Skip to content

docs: fix typos, grammar, and improve contributing docs #2159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Dark-Brain07 wants to merge 9 commits into
base: main
Choose a base branch
from
Open

docs: fix typos, grammar, and improve contributing docs #2159

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
484e918
fix: typo 'branc' to 'branch' in README
Dark-Brain07 Feb 1, 2026
432c4e6
fix: correct SDK wrapper path in README
Dark-Brain07 Feb 1, 2026
ad1c532
fix: update broken Code of Conduct link in README
Dark-Brain07 Feb 1, 2026
824aab5
docs: complete contribution prerequisites in CONTRIBUTING.md
Dark-Brain07 Feb 1, 2026
956aba6
docs: add checklist items to PR template
Dark-Brain07 Feb 1, 2026
fa44ced
fix: grammar 'an other' to 'another' in README
Dark-Brain07 Feb 1, 2026
83bc227
fix: grammar 'all PR' to 'all PRs' in README
Dark-Brain07 Feb 1, 2026
ad72920
docs: add explanatory comments to codecov.yml
Dark-Brain07 Feb 1, 2026
08993e7
docs: add Windows/Linux installation tip in README
Dark-Brain07 Feb 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Comment on lines +19 to +26
Copy link
Copy Markdown
Collaborator

@hugo-stacks hugo-stacks Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if that's useful as it, but I like the idea of removing this old "wip".

So that we don't have to update the versions in the future, I'd recommend setting:

  • Rust latest stable
  • Node latest LTS

Remove git and vscode, at this point, we expect contributors to know what they are doing.

And we could move the whole README prerequisites section here

4 changes: 3 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,6 @@
### Checklist

- [ ] Tests added in this PR (if applicable)

- [ ] Code builds without errors (`cargo build`)
- [ ] Code formatted with `cargo fmt-stacks`
Comment on lines +18 to +19
Copy link
Copy Markdown
Collaborator

@hugo-stacks hugo-stacks Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The CI while check that, no need for additional checkboxes

- [ ] Documentation updated (if applicable)
14 changes: 8 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Copy link
Copy Markdown
Collaborator

@hugo-stacks hugo-stacks Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs link updated (see conflicts I guess)


> **Tip:** If you're on Windows or Linux, check the installation docs for platform-specific instructions.

```bash
# Create a new project
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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`
Expand All @@ -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
Expand Down
4 changes: 4 additions & 0 deletions codecov.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down