Skip to content

Latest commit

 

History

History
95 lines (56 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

95 lines (56 loc) · 2.82 KB
Raw

Contributing Guide

Before you start

Please, make sure you have read the Tech crash course – you already know what Rosie, Jarbas, Whistleblower and the toolbox are about, right?

Also we have a 700+ members tech community to support you on our Telegram open tech group. Don't hesitate to reach us there.

Installing

As our stack is not a simple one we opted for standardizing our instructions do Docker Compose, which will help you spin up every service in a few commands.

Everything is expected to work with:

$ cp contrib/.env.sample .env
$ docker-compose up

Then .env file you just copied contains environment variables for Jarbas. Feel free to customize it.

Running Rosie

Example to run only Rosie:

$ docker-compose run --rm -v /tmp/serenata-data:/tmp rosie run chamber_of_deputies

Check Rosie's README.md for more details.

Running Jarbas

Example to run only Jarbas:

$ docker-compose up jarbas

Then browse from 0.0.0.0:8000. Check Jarbas's README.md for more details.

Running scripts from the research container

Example to run a given script from the research container:

$ docker-compose run --rm -v ./data:/tmp research python src/fetch_cnpj_info.py

The basics of contributing

A lot of discussions about ideas take place in the Issues section. There and interacting in the Telegram group you can catch up with what's going on and also suggest new ideas.

Unfortunatelly we have no public roadmap, barely an internal one – but you can follow what the core team is working on on Trello.

The Git basics

1. Fork this repository

There's a big button for that in GitHub interface, usually on the top right corner.

2. Clone your fork of the repository

$ git clone http://github.com/<YOUR-GITHUB-USERNAME>/serenata-de-amor.git

3. Create a feature branch

$ git checkout -b <YOUR-GITHUB-USERNAME>-new-stuff

Please, note that we prefix branch names with GitHub usernames, this helps us in keeping track of changes and who is working on them.

4. Do what you do best

Now it's your time to shine and write meaningful code to raise the bar of the project!

5. Commit your changes

$ git commit -am 'My pretty cool contribution'

6. Push to the branch to your fork

$ git push origin <YOUR-GITHUB-USERNAME>-new-stuff

7. Create a new Pull Request

From your fork at GitHub usually there is a button to open pull requests.