Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
guillermo-carrasco committed Sep 17, 2014
1 parent 4fd6ee1 commit 0cd0395
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#Contributing to PM code

In order to make a contribution to this pakcage, tehre are just a few things to have in mind.

__NOTE__: _Please make sure that there is already no exisiting [issue]((https://github.com/guillermo-carrasco/pm/issues)) related with whatever you want to report._

####To contribute:
1. Create an issue describing the bug/suggestion/improvement/... [here](https://github.com/guillermo-carrasco/pm/issues).
2. Fork this repository to your GitHub account
3. Make the necessary changes/additions to your forked pm repository
4. Please *make sure* that you've documented your code and changes using [sphinx](http://sphinx.readthedocs.org/en/latest/tutorial.html) syntax, as the documentation will be automatically generated using this engine, and published to ReadTheDocs \<add link to read the docs>
5. Pull Request and wait for some responsible to review and merge the code

That's it! And thanks a lot!

0 comments on commit 0cd0395

Please sign in to comment.