From ce8a84b6edebaff1847678d91ae6735774d61816 Mon Sep 17 00:00:00 2001 From: Jet Li Date: Wed, 18 Dec 2019 00:07:43 +0800 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ba25d6b --- /dev/null +++ b/CONTRIBUTING.md @@ -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.