diff options
| author | Louise Crow <louise.crow@gmail.com> | 2013-05-30 18:02:59 +0100 |
|---|---|---|
| committer | Louise Crow <louise.crow@gmail.com> | 2013-05-30 18:02:59 +0100 |
| commit | 4310fa8df4c3e3bcd3c7ef5cfa7f23314ed9dce1 (patch) | |
| tree | 0e976855da7b7944135b03bace78480eae75db79 | |
| parent | ad4f931918ae9a8f3347db0b572dffb1280a5fe9 (diff) | |
Add a rudimentary 'How to contribute' section - stolen shamelessly from @mlandauer
| -rw-r--r-- | README.md | 15 |
1 files changed, 15 insertions, 0 deletions
@@ -24,6 +24,21 @@ There's background information and a more documentation on of useful information (including a blog) on [the project website](http://alaveteli.org) +## How to contribute + +If you find what looks like a bug: + +* Check the [GitHub issue tracker](http://github.com/mysociety/alaveteli/issues/) + to see if anyone else has reported issue. +* If you don't see anything, create an issue with information on how to reproduce it. + +If you want to contribute an enhancement or a fix: + +* Fork the project on GitHub. +* Make your changes with tests. +* Commit the changes without making changes to any files that aren't related to your enhancement or fix. +* Send a pull request. + Looking for the latest stable release? It's on the [master branch](https://github.com/mysociety/alaveteli/tree/master). |