awesome-selfhosted/.github/PULL_REQUEST_TEMPLATE.md

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:

General

• Submit one item per pull request.
• If you are adding software forked from another project, please provide/link to a clear list of differences between both.
• You have searched the repository for any relevant issues or PRs, including closed ones.
• Additions are not already listed at any of awesome-sysadmin, staticgen.com, staticsitegenerators.net, dbdb.io.
• 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.

Requirements

• 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.

Formatting and description

• Additions are inserted preserving alphabetical order.
• Format your submission as follows, where Demo and Clients are optional. - [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`
  • Do not add a duplicate Source code link if it is the same as the main link.
  • Keep the short description under 250 characters and use sentence case for it, even if the project's webpage or readme uses another capitalisation such as title case, all caps, small caps or all lowercase.
  • Demo links should only be used for interactive demos, i.e. not video demonstrations.
• The Language tag is the main server-side requirement for the software. Don't include frameworks or specific dialects.
• Any license you add is in our list of licenses.

Proprietary & non-free Software

• Additions that depend on proprietary services outside the user's control must be marked ⚠.  - [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 that are not Free software must be added to non-free.md and have the license set to ⊘ Proprietary

Other

• Any category you create has the minimum requirement of 3 items. If not, your addition may be inserted into Miscellaneous.