BreizhHardware/awesome-selfhosted-data
1
0
Fork 0
mirror of https://github.com/BreizhHardware/awesome-selfhosted-data.git synced 2026-03-18 21:30:41 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc: contributing: add an 'other guidelines' section for soft guidelines (#500)

Browse Source 
* 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

---------

Co-authored-by: Rabenherz112 <rabenherz@theravenhub.com>
This commit is contained in:
nodiscc
2024-01-18 19:22:56 +00:00
committed by GitHub
parent 6d2fb15b2e
commit ae1d1e648b
2 changed files with 13 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@@ -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.

14
CONTRIBUTING.md
View File

@@ -84,7 +84,19 @@ 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.
- If the project is forked from another project, please add `(fork of $PROJECT)` at the end of the description.
- If the project distributes a single static binary, please add the programming language in which it is written.
### 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`.