diff --git a/AUTHORS.rst b/AUTHORS.rst new file mode 100644 index 0000000..dddf9be --- /dev/null +++ b/AUTHORS.rst @@ -0,0 +1,19 @@ + +# Contributions to the maya project + +## Creator & Maintainer + +- Kenneth Reitz `@kennethreitz `_ + + +## Contributors + +In chronological order: + +- Adam Nelson (`@adamn `_) +- Timo Furrer (`@timofurrer `_) +- Moinuddin Quadri (`@moin18 `_) +- Grigouze (`@grigouze `_) +- Tzu-ping Chung (`@uranusjr `_) +- aaronjeline (`@aaronjeline `_) +- jerry2yu (`@jerry2yu `_) diff --git a/README.rst b/README.rst index de28f4f..357c3da 100644 --- a/README.rst +++ b/README.rst @@ -100,3 +100,15 @@ Installation is easy, with pip:: ---------- `Say Thanks `_! + + +How to Contribute +----------------- + +#. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug. +#. Fork `the repository`_ on GitHub to start making your changes to the **master** branch (or branch off of it). +#. Write a test which shows that the bug was fixed or that the feature works as expected. +#. Send a pull request and bug the maintainer until it gets merged and published. :) Make sure to add yourself to AUTHORS_. + +.. _`the repository`: http://github.com/kennethreitz/maya +.. _AUTHORS: https://github.com/kennethreitz/maya/blob/master/AUTHORS.rst