mirror of
https://github.com/awesome-selfhosted/awesome-selfhosted
synced 2024-11-17 03:51:39 +00:00
Merge pull request #1460 from Kickball/updateContributing
Update contributing
This commit is contained in:
commit
d3dea2ce4a
2 changed files with 14 additions and 3 deletions
1
.github/CONTRIBUTING.md
vendored
1
.github/CONTRIBUTING.md
vendored
|
@ -9,6 +9,7 @@ Other recommendations:
|
|||
- To add a new entry, [edit the README.md file](https://github.com/Kickball/awesome-selfhosted/edit/master/README.md) through Github's web interface or a text editor, and send a Pull Request.
|
||||
- See [Editing files in another user's repository](https://help.github.com/articles/editing-files-in-another-user-s-repository/), [Creating Pull Requests](https://help.github.com/articles/creating-a-pull-request/), [Using Pull Requests](https://help.github.com/articles/using-pull-requests/) for help on sending your patch.
|
||||
- A script to help you format new entries is available at (it requires `make` to be installed): `git clone`/[download](https://github.com/Kickball/awesome-selfhosted/archive/master.zip) and enter the repository, run `make add` and follow the instructions.
|
||||
- A website to help you format new entries is available at https://n8225.github.io/
|
||||
- The list of contributors can be updated with `make contrib`.
|
||||
- Software with no development activity for 6-12 months may be removed from the list.
|
||||
|
||||
|
|
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
@ -2,16 +2,26 @@ 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 guidelines.
|
||||
- [ ] Your submissions are formatted according to the following requirements:
|
||||
|
||||
``- [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` ``
|
||||
``- [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:
|
||||
|
||||
``- [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`:
|
||||
|
||||
``- [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` main server-side `Language`/platform/requirement listed.
|
||||
- [ ] Any licenses you have added are in our [list of licenses](https://github.com/Kickball/awesome-selfhosted/blob/master/README.md#list-of-licenses).
|
||||
- [ ] You have searched the repository for any relevant [issues](https://github.com/Kickball/awesome-selfhosted/issues) or [PRs](https://github.com/Kickball/awesome-selfhosted/pulls), incluing 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.
|
||||
- [ ] Any software project you are adding to the list is actively maintained.
|
||||
|
|
Loading…
Reference in a new issue