awesome-selfhosted-data/.github/PULL_REQUEST_TEMPLATE.md
nodiscc ae1d1e648b
doc: contributing: add an 'other guidelines' section for soft guidelines (#500)
* doc: contributing: add an 'other guidelines' section for soft guidelines
- these guidelines are only relevant for a small fraction of additions but would significantly increase the number of requirements in the pull request template, so add them in a separate document
- move the guideline about providing a list of differences for forks to this document
- ref. https://github.com/awesome-selfhosted/awesome-selfhosted-data/issues/33#issuecomment-1886405382

---------

Co-authored-by: Rabenherz112 <rabenherz@theravenhub.com>
2024-01-18 19:22:56 +00:00

1.9 KiB

Thanks for taking the time to suggest an addition to awesome-selfhosted!

To ensure your Pull Request is dealt with swiftly, please check the following (check the boxes [x]):

  • Submit one item per pull request. This eases reviewing and speeds up inclusion.
  • You have searched the repository for any relevant issues or PRs, including closed ones.
  • Any software you are adding is not already listed at any of awesome-sysadmin, staticgen.com, staticsitegenerators.net, dbdb.io.
  • The file you are adding is formatted as described in addition.md.
  • Demo links should only be used for interactive demos, i.e. not video demonstrations.
  • Comments and unused optional fields have been removed.
  • The file you are adding uses kebab-case file naming, for example my-awesome-software.yml.
  • Values for platform are the main server-side requirements for the software. Don't include frameworks or specific dialects.
  • Any software project you are adding to the list is actively maintained.
  • Any software project you are adding was first released more than 4 months ago.
  • Any software project you are adding has working installation instructions.
  • You understand that your Pull Request will be merged ~1 week after approval, to allow for further comments if needed.