diff --git a/README.md b/README.md index 302b9c1..2b9801a 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome) +If you want to contribute, please read the [contribution guidelines](contributing.md). ## Table of Contents diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..b25c8cc --- /dev/null +++ b/contributing.md @@ -0,0 +1,18 @@ +# Contribution Guidelines + +Please ensure your pull request adheres to the following guidelines: + +- Search previous suggestions before making a new one, as yours may be a duplicate. +- Make an individual pull request for each suggestion. +- Titles should be [capitalized](http://grammar.yourdictionary.com/capitalization/rules-for-capitalization-in-titles.html). +- Keep descriptions short and simple. +- End all descriptions with a full stop/period. +- Order titles alphabetically within each category. +- Group commands for checking, enabling and disabling in one code block. +- Always use code fencing with the `bash` descriptor. +- Check your spelling and grammar. +- Make sure your text editor is set to remove trailing whitespace. +- The pull request and commit should have a useful title. +- New categories or improvements to the existing categorization are welcome. + +Thank you for your suggestions!