update pull request template with new guidelines (#402)
- use a single document for contributing guidelines, merge CONTRIBUTING.md with PULL_REQUEST_TEMPLATE.md - use the same formatting as https://github.com/awesome-selfhosted/awesome-selfhosted, including license and language/platform - old entries should be updated to the new format when time allows - the guidelies are roughly the same as for awesome-selfhosted, with the following variations: - descriptions must be max 80 charactes long - do not submit your own software - write a short paragraph explaining why the software is awesome - non-free software is not allowed - no duplicates with awesome-selfhosted - no list of licenses
This commit is contained in:
parent
7ce5bcd9b4
commit
e25ceb8996
23
.github/CONTRIBUTING.md
vendored
23
.github/CONTRIBUTING.md
vendored
@ -1,23 +0,0 @@
|
|||||||
# Contribution Guidelines
|
|
||||||
|
|
||||||
This is a compilation of **Free and Libre Open Source Software ([FLOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software))**. Restrictive licenses (aka Freeware, Shareware) are *not awesome*. Please adhere to the following guidelines or your Pull Request will be closed.
|
|
||||||
|
|
||||||
**Submitting your own software is not awesome**, unless you have a healthy ecosystem with a few contributors which aren't your sock puppet accounts.
|
|
||||||
|
|
||||||
## Commits
|
|
||||||
|
|
||||||
* Search previous suggestions before making a new one.
|
|
||||||
* Use the following format: `[RESOURCE](LINK) - DESCRIPTION.`
|
|
||||||
* Keep descriptions short (<80 characters).
|
|
||||||
* End descriptions with a full stop.
|
|
||||||
* Make an individual commit for each category.
|
|
||||||
* Order projects alphabetically.
|
|
||||||
|
|
||||||
## Pull Requests
|
|
||||||
|
|
||||||
* Consolidate multiple commits.
|
|
||||||
* Use imperative (e.g. add instead of added/adding) in the PR title.
|
|
||||||
* Include application names, categories and a link to the open source project page in the description.
|
|
||||||
* Write a short text why the application you're adding is actually awesome.
|
|
||||||
* Put only stuff on the list you or another contributor can personally recommend
|
|
||||||
* Recommending your own software is discouraged.
|
|
36
.github/PULL_REQUEST_TEMPLATE.md
vendored
36
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -1,9 +1,31 @@
|
|||||||
### Application name / category
|
<!-- DO NOT DELETE THE TEXT BELOW. Please make sure relevant boxes are checked [x] -->
|
||||||
[awesometool](https://example.com) / Devops
|
|
||||||
|
|
||||||
### Source URL
|
Thank you for taking the time to work on a PR for Awesome-Sysadmin!
|
||||||
https://github.example.com/repo
|
|
||||||
|
|
||||||
### why it is awesome
|
To ensure your PR is dealt with swiftly please check the following:
|
||||||
This tool is so awesome because it allows me to do awesome things in my
|
|
||||||
awesome corp, especially when I use it to manage awesome othersoftware.
|
- [ ] Your additions are [Free software](https://en.wikipedia.org/wiki/Free_software)
|
||||||
|
- [ ] Software your are submitting is not your own, unless you have a healthy ecosystem with a few contributors (which aren't your sock puppet accounts).
|
||||||
|
- [ ] Submit one item per pull request. This eases reviewing and speeds up inclusion.
|
||||||
|
- [ ] Format your submission as follows, where `Demo` and `Clients` are optional.
|
||||||
|
Do not add a duplicate `Source code` link if it is the same as the main link.
|
||||||
|
Keep the short description under 80 characters and use [sentence case](https://en.wikipedia.org/wiki/Letter_case#Sentence_case)
|
||||||
|
for it, even if the project's webpage or readme uses another capitalisation.
|
||||||
|
`Demo` links should only be used for interactive demos, i.e. not video demonstrations.
|
||||||
|
``- [Name](http://homepage/) - Short description, under 250 characters, sentence case. ([Demo](http://url.to/demo), [Source Code](http://url.of/source/code), [Clients](https://url.to/list/of/related/clients-or-apps)) `License` `Language` ``
|
||||||
|
- [ ] Additions are inserted preserving alphabetical order.
|
||||||
|
- [ ] Additions are not already listed at [awesome-selfhosted](https://github.com/awesome-foss/awesome-sysadmin)
|
||||||
|
- [ ] The `Language` tag is the main **server-side** requirement for the software. Don't include frameworks or specific dialects.
|
||||||
|
- [ ] You have searched the repository for any relevant [issues](https://github.com/awesome-foss/awesome-sysadmin/issues) or [PRs](https://github.com/awesome-foss/awesome-sysadmin/pulls), including closed ones.
|
||||||
|
- [ ] Any category you are creating has the minimum requirement of 3 items.
|
||||||
|
- [ ] Any software project you are adding to the list is actively maintained.
|
||||||
|
- [ ] The pull request title is informative, unlike "Update README.md".
|
||||||
|
Suggested titles: "Add aaa to bbb" for adding software aaa to section bbb,
|
||||||
|
"Remove aaa from bbb" for removing, "Fix license for aaa", etc.
|
||||||
|
|
||||||
|
|
||||||
|
--------------
|
||||||
|
|
||||||
|
### Why it is awesome
|
||||||
|
|
||||||
|
Please replace this with a short paragraph explaning why you think this software is awesome.
|
@ -6,7 +6,7 @@
|
|||||||
|
|
||||||
# Awesome Sysadmin [![certified awesome!](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome)
|
# Awesome Sysadmin [![certified awesome!](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome)
|
||||||
|
|
||||||
**A curated list of amazingly awesome open source sysadmin resources.** Please read [CONTRIBUTING](./.github/CONTRIBUTING.md) if you wish to add software and consider [donating](https://github.com/n1trux/awesome-donations) to the FLOSS projects you use regularly.
|
**A curated list of amazingly awesome Free and Open-Source sysadmin resources.** Please read the [Pull Request template](./.github/PULL_REQUEST_TEMPLATE.md) if you wish to add software and consider [donating](https://github.com/n1trux/awesome-donations) to the FLOSS projects you use regularly.
|
||||||
|
|
||||||
* [Awesome Sysadmin](#awesome-sysadmin)
|
* [Awesome Sysadmin](#awesome-sysadmin)
|
||||||
* [Automation](#automation)
|
* [Automation](#automation)
|
||||||
|
Loading…
Reference in New Issue
Block a user