dcsan / gitterbot

GitterBot / gitter chatbot with Wiki integration, and more!
https://gitter.im/dcsan/gitterbot
61 stars 83 forks source link

Add CONTRIBUTE file #136

Open abhisekp opened 9 years ago

abhisekp commented 9 years ago

Adding a contribute file helps detail the specifics about how a project’s maintainer would like to see patches or features contributed. This can include what tests to write, code syntax style or areas to focus on for patches.

Reference 1: http://contribute.md Reference 2: https://guides.github.com/activities/contributing-to-open-source/#project

Example: https://github.com/github/gitignore/blob/master/CONTRIBUTING.md

dcsan commented 9 years ago

is there a way to scrape the github graphs for this?

abhisekp commented 9 years ago

Scrap the github graphs? Why? Did you intend to make something like this https://waffle.io/FreeCodeCamp/FreeCodeCamp/metrics/throughput ?

This should be a simple markdown file that gives a guideline about contributing to the project which should include the environment setup, source code formatting styles, linting preference, etc.

dcsan commented 9 years ago

oh i thought you meant like a who's who for status? like: https://github.com/dcsan/gitterbot/graphs/contributors

but yeah a contrib guidelines, sure, feel free to write one.

abhisekp commented 9 years ago

Adding a CONTRIBUTING.mdfile, shows the following line when submitting an issue.

Please review the guidelines for contributing to this repository.

CONTRIBUTE