From a0e35739116b7bd4c71f3b44bb54d24d9ac5a511 Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sat, 13 Jan 2024 14:46:45 +0100 Subject: [PATCH] doc: contributing: add an 'other guidelines' section for soft guidelines - these guidelines are only relevant for a small fraction of additions but would significantly increase the number of requirements in the pull request template, so add them in a separate document - move the guideline about providing a list of differences for forks to this document - ref. https://github.com/awesome-selfhosted/awesome-selfhosted-data/issues/33#issuecomment-1886405382 --- .github/PULL_REQUEST_TEMPLATE.md | 1 - CONTRIBUTING.md | 12 +++++++++++- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0eaf94d097..0e70c70bc7 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -14,5 +14,4 @@ To ensure your Pull Request is dealt with swiftly, please check the following (c - [ ] 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 active project, please provide/link to a clear list of differences between both. - [ ] You understand that your Pull Request will be merged ~1 week after approval, to allow for further comments if needed. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 22bbe1321d..ef55921d86 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -84,7 +84,17 @@ To do this from Github's web interface: You can help cover domain name registration and renewal costs by pledging a small amount on [Liberapay ![](https://img.shields.io/liberapay/goal/awesome-selfhosted?logo=liberapay) ![](https://img.shields.io/liberapay/receives/awesome-selfhosted?logo=liberapay)](https://liberapay.com/awesome-selfhosted/) -### Other +### Other guidelines + +In addition to guidelines listed in the [Pull Request template](.github/PULL_REQUEST_TEMPLATE.md), these general rules help keep the list consistent: +- Please avoid redundant terms in project descriptions, such as _open-source_, _free_, _self-hosted_... as their presence on awesome-selfhosted already implies this. +- Prefer shorter forms for descriptions - for example, `Minimalist text adventure game` would be preferred to `A minimalist text adventure game` or `$PROJECT is a minimalist text adventure game`). +- If the the project has no documentation in English, please add `(documentation in $LANGUAGE)` at the end of the description. +- If the project is presented as an alternative to another service or application, please mention it as `(alternative to $PRODUCT1, $PRODUCT2)` at the end of the description. +- If you are adding software forked from another active project, please provide/link to a clear list of differences between both. + + +### Other operations **Rename a tag/category:** the tag must be renamed in the appropriate `tags/mytag.yml` file. All references to it must be updated in `tags/*.yml` and `software/*.yml`.