From 7a56282b48128a204b58c3fdad0de2e60898485f Mon Sep 17 00:00:00 2001 From: Rabenherz112 Date: Sun, 16 Jul 2023 22:24:42 +0200 Subject: [PATCH] Format pr template, add categories --- .github/PULL_REQUEST_TEMPLATE.md | 61 ++++++++++++++++++++------------ 1 file changed, 39 insertions(+), 22 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 3e46bde9..a5ad5cd5 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,31 +1,48 @@ - + 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: -- [ ] 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. - `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). +**General** + + +- [ ] Submit one item per pull request. +- [ ] 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. -- [ ] Any category you are creating has the minimum requirement of 3 items. - If not, your addition may be inserted into `Miscellaneous`. +- [ ] 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". + Suggested titles: "Add aaa to bbb" for adding software aaa to section bbb, + "Remove aaa from bbb" for removing, "Fix license for aaa", etc. + +**Requirements** + + - [ ] 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. -- [ ] 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. + +**Formatting and description** + + +- [ ] 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** + + +- [ ] 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** + + +- [ ] Any category you create has the minimum requirement of 3 items. + If not, your addition may be inserted into `Miscellaneous`.