Skip to content

Latest commit

 

History

History
73 lines (51 loc) · 3.49 KB

README.md

File metadata and controls

73 lines (51 loc) · 3.49 KB
Raw

Welcome to Alaveteli!

Build Status Dependency Status Coverage Status Code Climate Installability: Gold

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, a website produced by mySociety for making FOI requests in the UK.

We hope that by joining forces between teams across the world, we can all work together on producing the best possible software, and help move towards a world where governments approach transparency as the norm, rather than the exception.

Please join our mailing list at https://groups.google.com/group/alaveteli-dev and introduce yourself, or drop a line to [email protected] to let us know that you're using Alaveteli.

There's lots of useful information and documentation (including a blog) on the project website. There's background information and notes on our wiki, and upgrade notes in the doc/ folder

Installing

We've been working hard to make Alaveteli easy to install and re-use anywhere. Please see the project website for instructions on installing Alaveteli.

Compatibility

Every Alaveteli commit is tested by Travis on the following Ruby platforms

  • ruby-1.9.3
  • ruby-2.0.0
  • ruby-2.1.5
  • ruby-2.3.0

If you use a ruby version management tool (such as RVM or .rbenv) and want to use the default development version used by the alaveteli team (currently 2.0.0), you can create a .ruby-version symlink with a target of .ruby-version.example to switch to that automatically in the project directory.

How to contribute

If you find what looks like a bug:

  • Check the GitHub issue tracker 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 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 develop branch.

Looking for the latest stable release? It's on the master branch.

We have some more notes for developers on the project site.

Examples

See more at alaveteli.org.