Format pr template, add categories

This commit is contained in:
Rabenherz112 2023-07-16 22:24:42 +02:00 committed by GitHub
parent a7d9cc93d0
commit 7a56282b48
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,31 +1,48 @@
<!-- DO NOT DELETE THE TEXT BELOW if you are adding new software to the list. Please make sure relevant boxes are checked [x] --> <!-- DO NOT DELETE THE TEXT BELOW if you are adding new software to the list. -->
Thank you for taking the time to work on a PR for Awesome-Selfhosted! 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: 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. **General**
- [ ] Format your submission as follows, where `Demo` and `Clients` are optional. <!-- All checkboxes here must be checked (replace [ ] with [x]) -->
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) - [ ] Submit one item per pull request.
for it, even if the project's webpage or readme uses another capitalisation
such as title case, all caps, small caps or all lowercase.
`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 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](https://en.wikipedia.org/wiki/Free_software) must be added to `non-free.md` and have the license set to `⊘ Proprietary`
- [ ] Additions are inserted preserving alphabetical order.
- [ ] 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).
- [ ] 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](https://github.com/awesome-selfhosted/awesome-selfhosted/blob/master/README.md#list-of-licenses).
- [ ] 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.
- [ ] Any category you are creating has the minimum requirement of 3 items.
If not, your addition may be inserted into `Miscellaneous`.
- [ ] Any software project you are adding to the list is actively maintained.
- [ ] Any software project you are adding was first released more than 4 months ago.
- [ ] Any software project you are adding has working installation instructions.
- [ ] If you are adding software forked from another project, please provide/link to a clear list of differences between both. - [ ] If you are adding software forked from another project, please provide/link to a clear list of differences between both.
- [ ] 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.
- [ ] 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).
- [ ] The pull request title is informative, unlike "Update README.md". - [ ] The pull request title is informative, unlike "Update README.md".
Suggested titles: "Add aaa to bbb" for adding software aaa to section bbb, Suggested titles: "Add aaa to bbb" for adding software aaa to section bbb,
"Remove aaa from bbb" for removing, "Fix license for aaa", etc. "Remove aaa from bbb" for removing, "Fix license for aaa", etc.
**Requirements**
<!-- All checkboxes here must be checked (replace [ ] with [x]) -->
- [ ] Any software project you are adding to the list is actively maintained.
- [ ] Any software project you are adding was first released more than 4 months ago.
- [ ] Any software project you are adding has working installation instructions.
**Formatting and description**
<!-- All checkboxes here must be checked (replace [ ] with [x]) -->
- [ ] Additions are inserted preserving alphabetical order.
- [ ] Format your submission as follows, where `Demo` and `Clients` are optional.
``- [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` ``
- [ ] 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.
- [ ] `Demo` links should only be used for interactive demos, i.e. not video demonstrations.
- [ ] 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](https://github.com/awesome-selfhosted/awesome-selfhosted/blob/master/README.md#list-of-licenses).
**Proprietary & non-free Software**
<!-- Only check the checkboxes applicable to your software (replace [ ] with [x]) -->
- [ ] 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](https://en.wikipedia.org/wiki/Free_software) must be added to `non-free.md` and have the license set to `⊘ Proprietary`
**Other**
<!-- Only check the checkboxes applicable to your software (replace [ ] with [x]) -->
- [ ] Any category you create has the minimum requirement of 3 items.
If not, your addition may be inserted into `Miscellaneous`.