2022-09-13 19:39:14 +00:00
|
|
|
# Contribution Guidelines
|
|
|
|
|
|
|
|
|
|
Please note that this project is released with a
|
|
|
|
|
[Contributor Code of Conduct](CODE-OF-CONDUCT.md). By participating in this
|
|
|
|
|
project you agree to abide by its terms.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
Ensure your pull request adheres to the following guidelines:
|
|
|
|
|
|
2022-10-03 11:57:56 +00:00
|
|
|
- Use the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) (`<type>[optional scope]: <description>`)
|
|
|
|
|
- List items should be sorted alphabetically
|
|
|
|
|
- Search previous suggestions before making a new one, as yours may be a duplicate
|
|
|
|
|
- New categories, or improvements to the existing categorization are welcome
|
|
|
|
|
- Keep descriptions short and simple, but descriptive and non-promotional
|
2022-09-13 19:39:14 +00:00
|
|
|
|
|
|
|
|
Thank you for your suggestions!
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Updating your PR
|
|
|
|
|
|
|
|
|
|
A lot of times, making a PR adhere to the standards above can be difficult.
|
|
|
|
|
If the maintainers notice anything that we'd like changed, we'll ask you to
|
|
|
|
|
edit your PR before we merge it. There's no need to open a new PR, just edit
|
|
|
|
|
the existing one. If you're not sure how to do that,
|
|
|
|
|
[here is a guide](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md)
|
|
|
|
|
on the different ways you can update your PR so that we can merge it.
|
