Skip to content

Commit e0ec024

Browse files
committed
docs: update contributing and pull_request_template files
1 parent 8641c37 commit e0ec024

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

.github/pull_request_template.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,17 @@
2222
## Other information
2323

2424
<!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. -->
25+
26+
## Checklist
27+
28+
<!-- Please check if the PR fulfills these requirements. -->
29+
30+
- [ ] I have performed a self-review of my code
31+
- [ ] I have commented my code, particularly in hard-to-understand areas
32+
- [ ] My changes generate no new warnings
33+
- [ ] I have run `yarn prettier` and `yarn lint` without getting any errors
34+
- [ ] I have added tests that prove my fix is effective or that my feature works
35+
- [ ] New and existing unit tests pass locally with my changes
36+
37+
> [!IMPORTANT]
38+
> 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.

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ Pull requests are great if you want to add a feature or fix a bug. Here's a quic
3030

3131
7. Push to your fork and submit a pull request on our `dev` 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.
3232

33+
> [!IMPORTANT]
34+
> 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.
35+
3336
## CI (Github Actions)
3437

3538
We use GitHub Actions to verify if the code of your PR passes all our checks.

0 commit comments

Comments
 (0)