diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 21 insertions, 4 deletions
@@ -1,11 +1,11 @@ # Welcome to Alaveteli! -[](http://travis-ci.org/mysociety/alaveteli) [](https://gemnasium.com/mysociety/alaveteli) +[](http://travis-ci.org/mysociety/alaveteli) [](https://gemnasium.com/mysociety/alaveteli) [](https://coveralls.io/r/mysociety/alaveteli) [](https://codeclimate.com/github/mysociety/alaveteli) This is an open source project to create a standard, internationalised platform for making Freedom of Information (FOI) requests in different countries around the world. The software started off life as -[WhatDoTheyKnow](http://www.whatdotheyknow.com), a website produced by +[WhatDoTheyKnow](https://www.whatdotheyknow.com), a website produced by [mySociety](http://mysociety.org) for making FOI requests in the UK. We hope that by joining forces between teams across the world, we can @@ -19,10 +19,27 @@ drop a line to hello@alaveteli.org to let us know that you're using Alaveteli. Some documentation can be found in the [`doc/` folder](https://github.com/mysociety/alaveteli/tree/master/doc). -There's background information and a more documentation on +There's background information and more documentation on [our wiki](https://github.com/mysociety/alaveteli/wiki/Home/), and lots of useful information (including a blog) on [the project website](http://alaveteli.org) -Looking for the latest stable release? It's on the +## 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 a topic branch from the rails-3-develop branch. +* 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 against the rails-3-develop branch. + +Looking for the latest stable release? It's on the [master branch](https://github.com/mysociety/alaveteli/tree/master). + |