Skip to content
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.

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

chore: Update CONTRIBUTING.md #3921

Merged
merged 1 commit into from
Jan 2, 2024
Merged
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,10 @@

The easiest way to do this is to have multiple Conventional Commits while you work and then you can cherry-pick the smaller changes into separate branches for pull requesting.

### Typos and other small changes

Significant changes, like new features or important bug fixes, typically have a more pronounced impact on the project’s overall development. For smaller fixes, such as typos, we encourage you to report them instead of opening PRs. This approach helps us manage our resources effectively and ensures that every change contributes meaningfully to the project. PRs involving such smaller fixes will likely be closed and incorporated in PRs authored by the core team.

### Reviews

For any repository in the noir-lang organization, we require code review & approval by __one__ Noir team member before the changes are merged, as enforced by GitHub branch protection. Non-breaking pull requests may be merged at any time. Breaking pull requests should only be merged when the team has general agreement of the changes and is preparing a breaking release.
Expand Down Expand Up @@ -229,4 +233,4 @@
* **optimizer:** Compile Boolean to u1
```

[^1]: Currently, @critesjosh, @catmcgee and @signorecello. For Noir documentation, it is recommended to tag @signorecello

Check warning on line 236 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / Code

Unknown word (critesjosh)

Check warning on line 236 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / Code

Unknown word (catmcgee)

Check warning on line 236 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / Code

Unknown word (signorecello)

Check warning on line 236 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / Code

Unknown word (signorecello)
Loading