2023-02-01 13:33:06 +00:00
<!-- DO NOT DELETE THE TEXT BELOW if you are adding new software to the list. Please make sure relevant boxes are checked [x] -->
2021-12-25 20:31:03 +00:00
2016-09-05 13:13:02 +00:00
Thank you for taking the time to work on a PR for Awesome-Selfhosted!
2016-08-26 10:54:17 +00:00
To ensure your PR is dealt with swiftly please check the following:
2020-12-12 16:36:32 +00:00
- [ ] 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 250 characters and use [sentence case ](https://en.wikipedia.org/wiki/Letter_case#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.
2021-06-17 15:40:51 +00:00
`Demo` links should only be used for interactive demos, i.e. not video demonstrations.
2020-12-12 16:36:32 +00:00
``- [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` ``
2022-08-04 18:36:14 +00:00
- [ ] Additions that are not [Free software ](https://en.wikipedia.org/wiki/Free_software ) must be added to `non-free.md` and have the license set to `⊘ Proprietary`
2020-12-12 16:36:32 +00:00
- [ ] Additions are inserted preserving alphabetical order.
2023-05-10 14:41:43 +00:00
- [ ] Additions are not already listed at any of [awesome-sysadmin ](https://github.com/n1trux/awesome-sysadmin ), [staticgen.com ](https://www.staticgen.com/ ), [staticsitegenerators.net ](https://staticsitegenerators.net/ ), [dbdb.io ](https://dbdb.io/browse ).
2021-06-17 15:40:51 +00:00
- [ ] The `Language` tag is the main **server-side** requirement for the software. Don't include frameworks or specific dialects.
2020-12-12 16:36:32 +00:00
- [ ] Any license you add is in our [list of licenses ](https://github.com/awesome-selfhosted/awesome-selfhosted/blob/master/README.md#list-of-licenses ).
2019-10-27 12:47:01 +00:00
- [ ] You have searched the repository for any relevant [issues ](https://github.com/awesome-selfhosted/awesome-selfhosted/issues ) or [PRs ](https://github.com/awesome-selfhosted/awesome-selfhosted/pulls ), including closed ones.
2020-12-12 16:36:32 +00:00
- [ ] Any category you are creating has the minimum requirement of 3 items.
2023-07-09 12:42:07 +00:00
If not, your addition may be inserted into `Miscellaneous` .
2018-07-05 19:36:57 +00:00
- [ ] Any software project you are adding to the list is actively maintained.
2023-07-10 18:47:14 +00:00
- [ ] Any software project you are adding was first released more than 4 months ago.
2022-12-20 17:32:24 +00:00
- [ ] Any software project you are adding has working installation instructions.
2023-07-15 12:34:44 +00:00
- [ ] If you are adding software forked from another project, please provide/link to a clear list of differences between both.
2020-12-12 16:36:32 +00:00
- [ ] 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.
