awesome-sysadmin/.github/CONTRIBUTING.md
Crack Duck 1359f6271e
update CONTRIBUTING with bias notice
Submitting your own software is only cool if you have a huge healthy ecosystem. If you have 20 stars on github and you are the sole developer, that's not awesome. Consider what happens when you die (see also: truck factor) and lots of people depend on your software?
2020-03-17 22:34:10 +01:00

1.2 KiB

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.

Submitting your own software is not awesome, unless you have a healthy ecosystem with a few contributors which aren't your sock puppet accounts.

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
    • Recommending your own software is discouraged.