diff options
| author | nrew225 <nrew225@gmail.com> | 2018-07-05 19:29:26 +0000 |
|---|---|---|
| committer | nrew225 <nrew225@gmail.com> | 2018-07-05 19:29:26 +0000 |
| commit | d6b94a3fd50c8770c866ee76026141d6f61332a1 (patch) | |
| tree | f56d7ce5bb816d144932eca479c5a0f80482af98 /.github | |
| parent | Merge pull request #1453 from Kickball/fixTest (diff) | |
| download | awesome-selfhosted-d6b94a3fd50c8770c866ee76026141d6f61332a1.tar.gz awesome-selfhosted-d6b94a3fd50c8770c866ee76026141d6f61332a1.zip | |
Update contributing and pr template
- Add https://n8225.github.io/ to contributing
- Add guidelines for proprietary dependencies and propietary software to PR template
Diffstat (limited to '.github')
| -rw-r--r-- | .github/CONTRIBUTING.md | 1 | ||||
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 7 |
2 files changed, 6 insertions, 2 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index fb24419d..7dc56a60 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -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. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0effb7b8..4642568e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,10 +2,13 @@ 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` `` - + With proprietary dependencies: + ``- [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`. - [ ] 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). |