awesome-osx-command-line/contributing.md

21 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2015-09-22 17:37:20 -04:00
# 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.
2015-11-04 07:22:02 -05:00
- Titles need to be [capitalized](http://grammar.yourdictionary.com/capitalization/rules-for-capitalization-in-titles.html) properly. Don't be lazy. For help with this, see [Online Capitalize Tool](https://headlinecapitalization.com). Use *Chicago Manual of Style* rules.
2015-09-22 17:37:20 -04:00
- 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.
2015-10-18 14:09:33 -04:00
- Pull requests that are not fixed according to the comments within one week will be closed.
2015-10-18 16:17:48 -04:00
- Always use `folder` instead of `directory` in titles and descriptions.
2015-09-22 17:37:20 -04:00
Thank you for your suggestions!