mirror of
https://github.com/awesome-foss/awesome-sysadmin.git
synced 2025-04-19 08:28:05 +02:00
create PR template and move that and CONTRIBUTING into .github
This commit is contained in:
parent
9d3504832b
commit
0bbb606065
2 changed files with 9 additions and 0 deletions
24
.github/CONTRIBUTING.md
vendored
Normal file
24
.github/CONTRIBUTING.md
vendored
Normal file
|
@ -0,0 +1,24 @@
|
|||
# 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.
|
||||
|
||||
## 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
|
||||
|
||||
## Issues
|
||||
* Discussion, questions and bug reports only.
|
||||
* If you are sure software meets the guidelines, create a Pull Request (see above).
|
||||
* Check spelling and grammar.
|
||||
* Suggestions for improvements to existing structure are welcome.
|
9
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
9
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
@ -0,0 +1,9 @@
|
|||
### Application name / category
|
||||
[awesometool](https://example.com) / Devops
|
||||
|
||||
### Source URL
|
||||
https://github.example.com/repo
|
||||
|
||||
### why it is awesome
|
||||
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.
|
Loading…
Add table
Add a link
Reference in a new issue