Skip to content

Commit

Permalink
docs: update contributing and pull_request_template files
Browse files Browse the repository at this point in the history
  • Loading branch information
vplasencia committed Jan 14, 2025
1 parent 8641c37 commit e0ec024
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
14 changes: 14 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,17 @@
## Other information

<!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. -->

## Checklist

<!-- Please check if the PR fulfills these requirements. -->

- [ ] 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 prettier` 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.
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `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.

> [!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)

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

0 comments on commit e0ec024

Please sign in to comment.