kevin/awesome-sysadmin
1
Fork 0
mirror of https://github.com/awesome-foss/awesome-sysadmin.git synced 2024-12-26 14:01:17 -07:00
Code Issues Packages Projects Releases Wiki Activity
c3a1faace2
awesome-sysadmin/CONTRIBUTING.md
phre4k 0397416ede added recommendation requirement
2015-06-27 23:45:27 +02:00

1.2 KiB
Raw Blame History

Contribution Guidelines

This is a compilation of Free and Libre Open Source Software (FLOSS). Restrictive licenses (aka Freeware, Shareware) are not awesome. Please adhere to the following guidelines or your Pull Request will be closed.

Commits

  • Search previous suggestions before making a new one.
  • 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.
    • Order projects alphabetically.

Pull Requests

  • Consolidate multiple commits.
  • Use imperative (e.g. add instead of added/adding) in the PR title.
  • Include application names, categories and a link to the open source project page in the description.
  • Write a short text why the application you're adding is actually awesome.
    • Put only stuff on the list you or another contributor can personally recommend

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.