awesome-sysadmin/CONTRIBUTING.md

23 lines
911 B
Markdown
Raw Normal View History

2014-05-22 19:59:19 -04:00
# Contribution Guidelines
Ensure your pull request adheres to the following guidelines:
2014-05-22 19:59:19 -04:00
* This is an open source compilation.
* Check the license of the software is suitable.
* Search previous suggestions before making a new one.
* Don't create duplicates.
* Make an individual commit for each category.
* Consolidate multiple commits to a pull request.
* In pull request descriptions:
* Use imperative (e.g. add instead of added/adding).
* Include application names and categories.
* Include a link to the open source project page.
* Example: *Add mosh, openSSH to SSH*
2014-05-22 19:59:19 -04:00
* Use the following format: \[RESOURCE\]\(LINK\) - DESCRIPTION.
* Keep descriptions short.
* End descriptions with a full stop/period.
* Order projects alphabetically within each category.
* Check spelling and grammar.
* Improvements to the existing categorisation are welcome.
2014-05-22 19:59:19 -04:00
Thank you very much for your suggestions!