diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 2053a4cf..0e264796 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -29,10 +29,12 @@ -- [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] My changes generate no new warnings - [ ] I have run `yarn format` and `yarn lint` without getting any errors - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes + +> [!IMPORTANT] +> We do not accept minor grammatical fixes (e.g., correcting typos, rewording sentences) unless they significantly improve clarity in technical documentation. These contributions, while appreciated, are not a priority for merging. If there is a grammatical error feel free to message the team. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f67950b6..a385df06 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,6 +30,9 @@ Pull requests are great if you want to add a feature or fix a bug. Here's a quic 7. Push to your fork and submit a pull request on our `main` branch. Please provide us with some explanation of why you made the changes you made. For new features make sure to explain a standard use case to us. +> [!IMPORTANT] +> We do not accept minor grammatical fixes (e.g., correcting typos, rewording sentences) unless they significantly improve clarity in technical documentation. These contributions, while appreciated, are not a priority for merging. If there is a grammatical error feel free to message the team. + ## CI (Github Actions) Tests We use GitHub Actions to test each PR before it is merged.