Awesome-Mirrors/awesome-sysadmin
1
0
Fork 0
mirror of https://github.com/awesome-foss/awesome-sysadmin.git synced 2024-12-25 15:39:25 -05:00
Code Issues Packages Projects Releases Wiki Activity

trying to clarify contribution guidelines

Browse Source
This commit is contained in:
phre4k 2015-04-05 13:56:08 +02:00
parent adfaebbc22
commit c5494c5a63
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
CONTRIBUTING.md
View File

@ -1,22 +1,22 @@
# Contribution Guidelines # Contribution Guidelines
Ensure your pull request adheres to the following guidelines:
* This is an open source compilation. This is a compilation of **Free and Libre Open Source Software ([FLOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software))**. Restrictive licenses (aka Freeware, Shareware) are *not awesome*.
* Check the license of the software is suitable.
## Commits
* Search previous suggestions before making a new one. * Search previous suggestions before making a new one.
* Don't create duplicates. * Use the following format: `[RESOURCE](LINK) - DESCRIPTION.`
* Keep descriptions short (<80 characters).
* End descriptions with a full stop.
* Make an individual commit for each category. * Make an individual commit for each category.
* Consolidate multiple commits to a pull request. * Order projects alphabetically.
* In pull request descriptions: * Consolidate multiple commits.
* Use imperative (e.g. add instead of added/adding).
* Include application names and categories. ## Pull Requests
* Include a link to the open source project page. * Use imperative (e.g. add instead of added/adding) in the PR title.
* Example: *Add mosh, openSSH to SSH* * Include application names, categories and a link to the open source project page in the description.
* 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.
Thank you very much for your suggestions! ## Issues
* Discussion, questions and bug reports only.
* If you are sure software meets the guidelines, create a Pull Request (see above).
* Check spelling and grammar.
* Suggestions for improvements to existing structure are welcome.