CodeforAustralia/rerouteit

View on GitHub
CONTRIBUTING.md

Summary

Maintainability
Test Coverage
# CONTRIBUTE

This is the contribute.md of our project. Great to have you here. Here are a few ways you can help make this project better!

## Team members

* Project Lead - Chris D'Aloisio
* Technical Lead - *required*
* Design Lead - Pedro Rosas
* Programmer - Christopher Chow
* Programmer - Arvind CJ
* Designer - *required*

If you want to join the main team, sign-in and tap on to the project at [http://www.codeforaustralia.org/projects/reroute-it](http://www.codeforaustralia.org/projects/reroute-it)

## Learn, listen and discuss

* Project forum: [http://discuss.codeforaustralia.org/category/projects/reroute-it](http://discuss.codeforaustralia.org/category/projects/reroute-it)

## Adding new features

This section includes advice on how to build new features for the project & what kind of process it includes.

* This is how we like people to add new features:
    - create a new `feature/123-feature-name` branch where the number corresponds to an issue (where relevant)
    - push your completed branch to `origin`
* Here are some specifics on the coding style we prefer:
    - 2 spaces, not tabbed
    - if in doubt, follow the Github style guides
* This is how you send your pull request:
    - submit a pull request from your `feature` branch into the `develop` branch
* You should include the following tests:
    - any database level features
    - any exteral service aggregators

Don’t get discouraged! We estimate that the response time from the
maintainers is around: **48 hours**

# Bug triage

* You can help report bugs by filing them here:
    [https://github.com/CodeforAustralia/rerouteit/issues](https://github.com/CodeforAustralia/rerouteit/issues)
* You can look through the existing bugs here:
    [https://github.com/CodeforAustralia/rerouteit/issues](https://github.com/CodeforAustralia/rerouteit/issues)
* Look at existing bugs and help us understand if:
    * The bug is reproducible?
    * Is it reproducible in other environments (browsers)?
    * What are the steps to reproduce?
* You can remove duplicate bug reports


# Documentation

* For any code that doesn't easily describe what it does, please leave comments for future contributors!

# Your first bugfix
This section should help a person get started with their very first bug fix and thinking through the problem.

* If you have further questions, contact: chris.daloisio@codeforaustralia.org