From 799ef6fe7f70e21403e9a74645f6102d92cbe04f Mon Sep 17 00:00:00 2001 From: nodiscc <nodiscc@gmail.com> Date: Sat, 12 Sep 2020 16:34:07 +0200 Subject: [PATCH] =?UTF-8?q?Pull=20Request=20Template/README.md:=20clarify?= =?UTF-8?q?=20=E2=9A=A0=20symbol=20meaning,=20clarify=20formatting=20guide?= =?UTF-8?q?lines=20Fixes=20https://github.com/awesome-selfhosted/awesome-s?= =?UTF-8?q?elfhosted/issues/2207?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/PULL_REQUEST_TEMPLATE.md | 14 +++++--------- README.md | 2 +- 2 files changed, 6 insertions(+), 10 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 588aeaa7..99056d12 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,27 +2,23 @@ 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: -- [ ] Your submissions are formatted according to the following requirements: - +- [ ] Your submissions are formatted according to the following requirements (`Demo` and `Clients` are optional, don't add a duplicate `Source code` link if it is the same as the main link): + ``- [Name](http://homepage/) - Short description, less than 250 characters. ([Demo](http://url.to/demo), [Source Code](http://url.of/source/code), [Clients](https://url.to/list/of/related/clients-or-apps)) `License` `Language` `` -Depends on proprietary services: +- [ ] If your additions depend on proprietary services outside the user's control, they must be marked `⚠`. ``- [Name](http://homepage/) `⚠` - Short description, less than 250 characters. ([Demo](http://url.to/demo), [Source Code](http://url.of/source/code), [Clients](https://url.to/list/of/related/clients-or-apps)) `License` `Language` `` -Non-free software in `non-free.md`: +- [ ] Additions that are not [Free software](https://en.wikipedia.org/wiki/Free_software) must be added to `non-free.md` and marked `⊘ Proprietary`: ``- [Name](http://homepage/) `⊘ Proprietary` - Short description, less than 250 characters. ([Demo](http://url.to/demo), [Source Code](http://url.of/source/code), [Clients](https://url.to/list/of/related/clients-or-apps)) `Language` `` - - [ ] Your additions are ordered alphabetically. -- [ ] Your additions are [Free software](https://en.wikipedia.org/wiki/Free_software), or if not they have been added to [non-free](non-free.md) and marked `⊘ Proprietary`. -- [ ] If your additions depend on proprietary services outside the user's control, they must be marked `⚠`. - [ ] Your additions are not already listed at [awesome-sysadmin](https://github.com/n1trux/awesome-sysadmin) (IT infrastructure management), [staticgen.com](https://www.staticgen.com/) or [staticsitegenerators.net](https://staticsitegenerators.net/) (static site generators). -- [ ] Your additions have their `License` and main server-side `Language`/platform/requirement listed. +- [ ] The `Language` tag is the main server-side requirement for the software - don't include frameworks/specifc dialects. - [ ] Any licenses you have added are 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. -- [ ] If the main link of your addition points to the program's source code, there is no need to add a duplicate _Source Code_ link. The _Demo_ and _Clients_ links are not mandatory. - [ ] Any category you are creating has the minimum requirement of 3 items. If not, your addition may be inserted into `Misc/Other`. - [ ] Any software project you are adding to the list is actively maintained. - [ ] The pull request title is "Add aaa to bbb" for adding software aaa to section bbb. Do not call it "Update README.md". diff --git a/README.md b/README.md index 3b6f7112..ad6889ac 100644 --- a/README.md +++ b/README.md @@ -1592,7 +1592,7 @@ See also [Documentation Generators](#documentation-generators), [Wikimatrix](htt **[`^ back to top ^`](#)** -- `⚠ ` - Depends on a third party network service +- `⚠ ` - Depends on a proprietary service outside the user's control - `0BSD` - [BSD Zero-Clause Licence](https://opensource.org/licenses/0BSD) - `AAL` - [Attribution Assurance License](https://opensource.org/licenses/AAL) - `AGPL-3.0` - [GNU Affero General Public License 3.0](https://www.gnu.org/licenses/agpl-3.0)