Create CONTRIBUTING.md

This commit is contained in:
Jet Li 2019-12-18 00:07:43 +08:00 committed by GitHub
parent 2dd82f6e65
commit ce8a84b6ed
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

23
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,23 @@
# 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:
- Search previous suggestions before making a new one, as yours may be a duplicate.
- New categories, or improvements to the existing categorization are welcome.
- Use the following format: `[TITLE](LINK) - DESCRIPTION.`
- Description is optional but strongly recommended.
- Keep descriptions short and simple, but descriptive.
- End all descriptions with a full stop/period.
- Check your spelling and grammar.
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. If you're not sure how to do that, [here is a guide](https://github.com/RichardLitt/docs/blob/master/amending-a-commit-guide.md) on the different ways you can update your PR so that we can merge it.