stonewareslord/awesome-osx-command-line
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add contribution guidelines

Browse Source
This commit is contained in:
Marcel Bischoff 2015-09-22 23:37:20 +02:00
parent 6c6116ae9d
commit 55793e4e84
2 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -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

18
contributing.md Normal file
View File

@ -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!