Skip to content

Commit ae1d1e6

Browse files
doc: contributing: add an 'other guidelines' section for soft guidelines (#500)
* 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. #33 (comment) --------- Co-authored-by: Rabenherz112 <[email protected]>
1 parent 6d2fb15 commit ae1d1e6

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

.github/PULL_REQUEST_TEMPLATE.md

-1
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,4 @@ To ensure your Pull Request is dealt with swiftly, please check the following (c
1414
- [ ] Any software project you are adding to the list is actively maintained.
1515
- [ ] Any software project you are adding was first released more than 4 months ago.
1616
- [ ] Any software project you are adding has working installation instructions.
17-
- [ ] If you are adding software forked from another active project, please provide/link to a clear list of differences between both.
1817
- [ ] You understand that your Pull Request will be merged ~1 week after approval, to allow for further comments if needed.

CONTRIBUTING.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,19 @@ To do this from Github's web interface:
8484
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/)
8585

8686

87-
### Other
87+
### Other guidelines
88+
89+
In addition to guidelines listed in the [Pull Request template](.github/PULL_REQUEST_TEMPLATE.md), these general rules help keep the list consistent:
90+
- Please avoid redundant terms in project descriptions, such as _open-source_, _free_, _self-hosted_... as their presence on awesome-selfhosted already implies this.
91+
- 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`).
92+
- If the the project has no documentation in English, please add `(documentation in $LANGUAGE)` at the end of the description.
93+
- 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.
94+
- If you are adding software forked from another active project, please provide/link to a clear list of differences between both.
95+
- If the project is forked from another project, please add `(fork of $PROJECT)` at the end of the description.
96+
- If the project distributes a single static binary, please add the programming language in which it is written.
97+
98+
99+
### Other operations
88100

89101
**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`.
90102

0 commit comments

Comments
 (0)