Welcome
First of all, thank you for your interest in Spokenvote. It is our sincere desire that your participation in this project turns out to be not only meaningful and inspiring, but also a great deal of fun. Welcome aboard!
Contributing
SpokenVote is an open source application developed under the MIT or the GNU GPLv2 or later licenses and is available for free distribution here on Github. We welcome your participation in building this tool for all of of humanity. Here are a few simple guidelines we have found helpful in the collaboration process:
Get in the Loop
Join the SpokenVote Development and SpokenVote Users Groups to participate in discussions and keep up with the latest developments. If you will be writing code, you will want to join the Development list. If you are only concerned with design elements or the core functional logic of the system, join the Design list. If you are like most of us and are interested in both, by all means join both list.
Claim a Task
First get a free account on Trello where we manage the project tasks. Then ask to be added to our Trello board so you can see, make and accept work tickets. The Trello board is where you can find detailed information about how you might be able to contribute, what is essential to our forward progress, and the detailed requirements of each element that needs to be built. The next important piece of Spokenvote might come from you. Here is where you can find out about the next bite-sized piece the project needs.
Git-style Fork and Branch Workflow
We use the Git-style "fork and branch" workflow. So first you will want to fork the master repository, using the fork option in the upper right of the main Github code screen. We have found it best to work in small chunks, using your own separate branches within your own repository. When a piece of code is ready for inclusion in the master project, you will just send a pull request using that option on your Github repository screen. Be sure to look at the readme.md in the repository for detailed information on setting up your Rails environment, a local database, and details for forking and submitting pull requests.
Come Hack with Us
If you live near or are visiting the Bay Area, please come join our bi-weekly coding sessions. As of early 2014 we are meeting regularly San Francisco and Mountain View, CA on Sunday evenings. We usually gather from 6:30 to 9:30 to discuss the project, write code, and typically order in some pizza to share. Be sure to check the Meetup site for up-to-date times and location.
Support or Contact
Having trouble? Check out the getting started documentation or post an issue and we’ll help you sort it out.
