mirror of
https://github.com/awesome-selfhosted/awesome-selfhosted.git
synced 2024-12-23 06:26:46 +01:00
54317bca4f
Some improvements to the pull request template: - require sentence case for short description, for consistency - suggest submitting one item per pull request, to ease review - improve template formatting, for pull request readability
3.0 KiB
3.0 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:
- Submit one item per pull request. This eases reviewing and speeds up inclusion.
- Format your submission as follows, where
Demo
andClients
are optional. Do not add a duplicateSource 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.- [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 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 marked⊘ Proprietary
:- [Name](http://homepage/) `⊘ Proprietary` - 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)) `Language`
- Additions are inserted preserving alphabetical order.
- Additions are not already listed at any of
- awesome-sysadmin (IT infrastructure management),
- awesome-analytics (analytics),
- staticgen.com
- staticsitegenerators.net (static site generators).
- 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.
- 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 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.