Create CONTRIBUTING.md

This commit is contained in:
Ramit Surana
2016-01-06 20:13:48 +05:30
parent b72005b45a
commit 89ce9586af

29
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,29 @@
## Contributing Guidelines:
We appreciate and recognize all contributors.
Contribution Guidelines
* To add to the list: Submit a pull request
* To remove from the list: Submit a pull request
* Want to change something: Submit a pull request
* Want to try something else: Submit a pull request
* Don't know what to do: Submit a pull request
* Each item should be limited to one link
* The link should be the name of the package or project or website
* Descriptions should be clear and concise (read it out loud to be sure)
* Descriptions should follow the link, on the same line
* If you want to add more than one link, please don't do all PR on the exact same line, it usually results in conflicts and your PR cannot be automatically merged...
* Please contribute links to packages/projects you have used or are familiar with. This will help ensure high-quality entries.
Quality standard
To be on the list, it would be nice if entries adhere to these quality standards:
* Generally useful to the community
* Clearly "what is it" --> which category it belongs : article, video, twitter account, ...
* Clearly stating "what is it for": mention the problem it solves. Just try your best, make it clear for the next person.
* Solves a real problem (even a small one)
* If it is a WIP (work in progress, not safe for production), mention it.
Abstract taken from [awesome-docker](https://github.com/veggiemonk/awesome-docker/blob/master/CONTRIBUTING.md)