e25ceb8996
- use a single document for contributing guidelines, merge CONTRIBUTING.md with PULL_REQUEST_TEMPLATE.md - use the same formatting as https://github.com/awesome-selfhosted/awesome-selfhosted, including license and language/platform - old entries should be updated to the new format when time allows - the guidelies are roughly the same as for awesome-selfhosted, with the following variations: - descriptions must be max 80 charactes long - do not submit your own software - write a short paragraph explaining why the software is awesome - non-free software is not allowed - no duplicates with awesome-selfhosted - no list of licenses
31 lines
2.2 KiB
Markdown
31 lines
2.2 KiB
Markdown
<!-- DO NOT DELETE THE TEXT BELOW. Please make sure relevant boxes are checked [x] -->
|
|
|
|
Thank you for taking the time to work on a PR for Awesome-Sysadmin!
|
|
|
|
To ensure your PR is dealt with swiftly please check the following:
|
|
|
|
- [ ] Your additions are [Free software](https://en.wikipedia.org/wiki/Free_software)
|
|
- [ ] Software your are submitting is not your own, unless you have a healthy ecosystem with a few contributors (which aren't your sock puppet accounts).
|
|
- [ ] 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 80 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.
|
|
`Demo` links should only be used for interactive demos, i.e. not video demonstrations.
|
|
``- [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 are inserted preserving alphabetical order.
|
|
- [ ] Additions are not already listed at [awesome-selfhosted](https://github.com/awesome-foss/awesome-sysadmin)
|
|
- [ ] The `Language` tag is the main **server-side** requirement for the software. Don't include frameworks or specific dialects.
|
|
- [ ] You have searched the repository for any relevant [issues](https://github.com/awesome-foss/awesome-sysadmin/issues) or [PRs](https://github.com/awesome-foss/awesome-sysadmin/pulls), including closed ones.
|
|
- [ ] Any category you are creating has the minimum requirement of 3 items.
|
|
- [ ] 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.
|
|
|
|
|
|
--------------
|
|
|
|
### Why it is awesome
|
|
|
|
Please replace this with a short paragraph explaning why you think this software is awesome. |