Skip to content

Latest commit

 

History

History
42 lines (32 loc) · 2.95 KB

CONTRIBUTING.md

File metadata and controls

42 lines (32 loc) · 2.95 KB
Raw

Contributing

Thank you for showing interest in contributing to this list. In general, adding a contribution is pretty straight-forward.

Guidance

To get started, follow these steps to open a pull request:

  1. Make sure the software qualifies according to the requirements.
  2. Create a fork of this repository where you commit your changes to.
  3. Edit the readme file and add any information you would like to be included in this repository.
  4. After you're done with your edit, make sure you followed all the rules and open a pull request.
  5. Your request will then be reviewed as soon as a maintainer gets around, and it will either be merged or changes will be requested. In case there is anything wrong, the PR can also be closed with a comment.

Software Requirements

  • Open-Source
    • This step should be pretty self-explanatory. But the software's full source code should be published under an open-source licence.
  • Actively Maintained
    • In general, any software in this list should still be actively maintained.
  • Secure
    • There should be no highly critical issues that are not being dealt with at the moment.
    • If there have been any incidents in the past they have to be dealt with transparently, promptly and effectively. Lessons learned should if possible be communicated.
  • Privacy Respecting
    • The project should hold a user's privacy to the highest standards and not collect more than necessary data. Any collected info should also be stored securely.
  • Transparent
    • It should be very clear what the goal of the software is and what the motives of the maintainers are. The funding model should be clear (if existing).
  • Ethical
    • All projects on this list have to be ethically just. This means no suppression of free speech, discrimination, shady practices or disregard of any human rights.

Exceptions are possible. However, these would have to be thoroughly reviewed by the community case by case and need a good explanation. Such solutions should probably be listed under honourable mentions with some sort of disclaimer.

Rules

Before opening a pull request, make sure that your contribution follows these guidelines.

  • Make sure that your PR is not a duplicate and check if there have been similar PRs in the past that we're not accepted for a reason.
  • Don't abandon PRs and make sure to answer any issues or comments in ~1 week.
  • Don't include multiple modifications in one PR. Keep separate issues in separate requests.
  • The commits have to be named in a good manner. "Updated README.md" will be rejected. To add a software, use the pattern "Adds [software] to [category]".
  • If you are in any way affiliated with the project you are trying to add, you have to fully disclose your affiliation. Self advertisement is no issue as long as you are transparent about it and make sure your project meets the requirements like everything else.
  • Don't open WIP or Draft pull requests. Any PR should be 100% finished before submission.