awesome-sysadmin/.github/PULL_REQUEST_TEMPLATE.md
kokomo123 5e3857842d
doc: PR template: adjust link for awesome-selfhosted (#549)
Co-authored-by: nodiscc <nodiscc@gmail.com>
2024-01-27 11:34:11 +00:00

2.8 KiB

Thank you for taking the time to work on a PR for Awesome-Sysadmin!

To ensure your PR is dealt with swiftly please check the following:

  • Your additions are Free software
  • Software your are submitting is not your own, unless you have a healthy ecosystem with a few contributors (which aren't your sock puppet accounts).
  • Submit one item per pull request. This eases reviewing and speeds up inclusion.
  • Format your submission as follows, where Demo and Clients are optional. Do not add a duplicate Source code link if it is the same as the main link. Keep the short description under 80 characters and use sentence case for it, even if the project's webpage or readme uses another capitalisation. Demo links should only be used for interactive demos, i.e. not video demonstrations. - [Name](http://homepage/) - Short description, under 250 characters, sentence case. ([Demo](http://url.to/demo), [Source Code](http://url.of/source/code), [Clients](https://url.to/list/of/related/clients-or-apps)) `License` `Language`
  • Additions are inserted preserving alphabetical order.
  • Additions are not already listed at awesome-selfhosted
  • The Language tag is the main server-side requirement for the software. Don't include frameworks or specific dialects.
  • You have searched the repository for any relevant issues or PRs, including closed ones.
  • Any category you are creating has the minimum requirement of 3 items.
  • Any software project you are adding to the list is actively maintained.
  • The pull request title is informative, unlike "Update README.md". Suggested titles: "Add aaa to bbb" for adding software aaa to section bbb, "Remove aaa from bbb" for removing, "Fix license for aaa", etc.

Please take some time to answer the following questions as best you can:

  • Why is it awesome?

Replace this text with your answer.

  • Have you used it? For how long?

Replace this text with your answer.

  • Is this in a personal or professional setup?

Replace this text with your answer.

  • How many devices/users/services/... do you manage with it?

Replace this text with your answer.

  • Biggest pros/cons compared to other solutions?

Replace this text with your answer.

  • Any other comments about your use case, things you've found excellent, limitations you've encountered... ?