diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index db4b3d5..0637c1e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,10 +2,15 @@ Please ensure your pull request adheres to the following guidelines: * This is an open source compilation, please check that the license of the software is suitable. -* Please search previous suggestions before making a new one, as yours may be a duplicate. -* Please make an individual pull request for each suggestion. +* Search previous suggestions before making a new one, as yours may be a duplicate. +* Make an individual commit for each suggestion. + * Consolidate multiple commits to a pull request. +* In pull request descriptions: + * Don't use past tense or present progressive (added, adding) + * Include the application names and categories + * Example: *Add mosh, openSSH to SSH* * Use the following format: \[RESOURCE\]\(LINK\) - DESCRIPTION. -* Keep descriptions short and simple. +* Keep descriptions short. * End all descriptions with a full stop/period. * Order projects alphabetically within each category. * Check your spelling and grammar. diff --git a/README.md b/README.md index 52321aa..fc8dcec 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Awesome Sysadmin -A curated list of amazingly awesome open source sysadmin resources inspired by [Awesome PHP](https://github.com/ziadoz/awesome-php) +**A curated list of amazingly awesome open source sysadmin resources.** You can check out [other awesome lists](https://github.com/bayandin/awesome-awesomeness) as well. Please read [CONTRIBUTING](./CONTRIBUTING.md) if you wish to add software. * [Awesome Sysadmin](#awesome-sysadmin) * [Automation](#automation) @@ -584,6 +584,3 @@ Various resources, such as books, websites and articles, for improving your skil * [Ops School](http://www.opsschool.org) - Comprehensive program that will help you learn to be an operations engineer. * [Digital Ocean Tutorials](https://www.digitalocean.com/community/tutorials) - A surprisingly vast resource for getting the basics of certain applications, tools, or even systems administration topics. - -# Contributing -Please see [CONTRIBUTING](https://github.com/kahun/awesome-sysadmin/blob/master/CONTRIBUTING.md) for details.