aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexis Metaireau <alexis@notmyidea.org>2011-09-09 21:32:52 +0200
committerAlexis Metaireau <alexis@notmyidea.org>2011-09-09 21:32:52 +0200
commit20f6f204cfc704b7486cfd9f36a643073fdc57fa (patch)
tree41e8ca8d3d887dd5f642eaf9359ad3e7ba8ed93a
parentef353d643c274d19e7816e9cfa436e38f1d1edea (diff)
downloadihatemoney-mirror-20f6f204cfc704b7486cfd9f36a643073fdc57fa.zip
ihatemoney-mirror-20f6f204cfc704b7486cfd9f36a643073fdc57fa.tar.gz
ihatemoney-mirror-20f6f204cfc704b7486cfd9f36a643073fdc57fa.tar.bz2
update the README with information about how to contribute
-rw-r--r--README.rst27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 8b32bb5..2cd41cc 100644
--- a/README.rst
+++ b/README.rst
@@ -32,3 +32,30 @@ To deploy it, I'm using gunicorn and supervisord::
3. reload both nginx and supervisord. It should be working ;)
Don't forget to set the right permission for your files !
+
+How to contribute
+=================
+
+There are different ways to help us, regarding if you are a designer,
+a developer or just an user.
+
+As a developer
+--------------
+
+The best way to contribute code is to write it and to make a pull request on
+github. Please, think about updating and running the tests before asking for
+a pull request as it will help us to maintain the code clean and running.
+
+As a designer / Front-end developer
+-----------------------------------
+
+Feel free to provide us mockups or to involve yourself into the discussions
+hapenning on the github issue tracker. All ideas are welcome. Of course, if you
+know how to implement them, feel free to fork and make a pull request.
+
+End-user
+--------
+
+You just wanted to have a look at the application and found a bug? Please tell
+us and go fill a new issue:
+https://github.com/ametaireau/budget-manager/issues/new