awesome-selfhosted/.github/PULL_REQUEST_TEMPLATE.md

2.4 KiB

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

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

  • Your submissions are formatted according to the following requirements (Demo and Clients are optional, don't add a duplicate Source code link if it is the same as the main link):

- [Name](http://homepage/) - Short description, less than 250 characters. ([Demo](http://url.to/demo), [Source Code](http://url.of/source/code), [Clients](https://url.to/list/of/related/clients-or-apps)) `License` `Language`

  • If your additions depend on proprietary services outside the user's control, they must be marked .

- [Name](http://homepage/) `⚠` - Short description, less than 250 characters. ([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 that are not Free software must be added to non-free.md and marked ⊘ Proprietary:

- [Name](http://homepage/) `⊘ Proprietary` - Short description, less than 250 characters. ([Demo](http://url.to/demo), [Source Code](http://url.of/source/code), [Clients](https://url.to/list/of/related/clients-or-apps)) `Language`

  • Your additions are ordered alphabetically.
  • Your additions are not already listed at awesome-sysadmin (IT infrastructure management), staticgen.com or staticsitegenerators.net (static site generators).
  • The Language tag is the main server-side requirement for the software - don't include frameworks/specifc dialects.
  • Any licenses you have added are in our list of licenses.
  • 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. If not, your addition may be inserted into Misc/Other.
  • Any software project you are adding to the list is actively maintained.
  • The pull request title is "Add aaa to bbb" for adding software aaa to section bbb. Do not call it "Update README.md".