2018-10-09 19:17:49 -04: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:
|
|
|
|
|
|
2018-10-14 07:58:44 -04:00
|
|
|
- Include a description of the link you're adding if possible
|
|
|
|
|
- If you're changing section headers, ensure you update the contents at the top too
|
|
|
|
|
- If you're adding a new section, ensure you give it a unique name
|
2018-10-09 19:17:49 -04: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.
|
