awesome-selfhosted/.github/CONTRIBUTING.md
2016-08-30 22:54:55 +02:00

2.0 KiB

Contributing

Please join us on chat to clarify any questions.

  • The syntax for links is [Name](http://homepage/) - Short description. ([Demo](http://url.to/demo), [Source Code](http://url.of/source/code)) `License` `Language```. All projects should have their **license** and main server-side **language**/platform/requirement listed, and a description at most 250 characters long. The ⚠ character must be inserted after a service's name that relies on a third party service, e.g Name ⚠ - Short description.```.
  • To add an entry: clone/download and enter the repository, run make add and follow the instructions; or edit the README.md file directly. See Editing files in another user's repository, Creating Pull Requests, Using Pull Requests for help on sending your patch.
  • A minimum of 3 entries are required to start a new category, otherwise add to the Misc/Other category.
  • Entries should be ordered alphabetically.
  • Non-Free software must be marked ⊘ Proprietary next to the title, and added to non-free.md.
  • Check current issues and Pull Requests, as well as closed issues/PRs.
  • The list of contributors can be updated with make contrib. Several checks are available: make noexternallink; make missinglicenselanguage; make nofullstop
  • Software with no development activity for 6-12 months may be removed from the list.