Mirror of Awesome Self Hosted
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

31 lines
3.0 KiB

  1. Thank you for taking the time to work on a PR for Awesome-Selfhosted!
  2. To ensure your PR is dealt with swiftly please check the following:
  3. - [ ] Submit one item per pull request. This eases reviewing and speeds up inclusion.
  4. - [ ] Format your submission as follows, where `Demo` and `Clients` are optional.
  5. Do not add a duplicate `Source code` link if it is the same as the main link.
  6. Keep the short description under 250 characters and use [sentence case](https://en.wikipedia.org/wiki/Letter_case#Sentence_case)
  7. for it, even if the project's webpage or readme uses another capitalisation
  8. such as title case, all caps, small caps or all lowercase.
  9. ``- [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` ``
  10. - [ ] Additions that depend on proprietary services outside the user's control must be marked `⚠`.
  11. ``- [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` ``
  12. - [ ] Additions that are not [Free software](https://en.wikipedia.org/wiki/Free_software)
  13. must be added to `non-free.md` and marked `⊘ Proprietary`:
  14. ``- [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` ``
  15. - [ ] Additions are inserted preserving alphabetical order.
  16. - [ ] Additions are not already listed at any of
  17. - [awesome-sysadmin](https://github.com/n1trux/awesome-sysadmin) (IT infrastructure management),
  18. - [awesome-analytics](https://github.com/onurakpolat/awesome-analytics) (analytics),
  19. - [staticgen.com](https://www.staticgen.com/)
  20. - [staticsitegenerators.net](https://staticsitegenerators.net/) (static site generators).
  21. - [ ] The `Language` tag is the main server-side requirement for the software - don't include frameworks or specific dialects.
  22. - [ ] Any license you add is in our [list of licenses](https://github.com/awesome-selfhosted/awesome-selfhosted/blob/master/README.md#list-of-licenses).
  23. - [ ] 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.
  24. - [ ] Any category you are creating has the minimum requirement of 3 items.
  25. If not, your addition may be inserted into `Misc/Other`.
  26. - [ ] Any software project you are adding to the list is actively maintained.
  27. - [ ] The pull request title is informative, unlike "Update README.md".
  28. Suggested titles: "Add aaa to bbb" for adding software aaa to section bbb,
  29. "Remove aaa from bbb" for removing, "Fix license for aaa", etc.