Thanks for joining our project! First we’ll do some quick setup to bring you into the project. Then, optionally read on for more info and background about our goals and work plan.
1) Fork our repository on Github. Is this your first time forking? Read detailed instructions here
2) Join our slack channel. Between in-person sessions, we communicate via Slack. Go to the Code for DC homepage and click the link next to ‘Slack Team’. There are several Slack channels - a housing-insights channel as well as a channel for each team (data, D3, and prototype).
3) Clone your fork of the repository to your computer. Be sure to add both the ‘origin’ and ‘codefordc’ remote repositories so that you can use our triangular workflow - just cloning the repository is not enough. Instructions are here.
4) Fill out our onboarding survey. It’s mostly things like usernames so we can add you to the project.
5) System setup: Choose your setup based on what you will be working on:
Just analyzing data: Connect to our RDS database
Adding data, documenting data, and Python coding: Setup Docker
Front end development: Run Jekyll
We hold weekly come-if-you-can work sessions every Tuesday night. We also meet whenever Code for DC meets. Specific dates and locations, including save-to-calendar links, are on our latest updates page
Neal (the project manager) sends a weekly email update to contributors.
Between sessions, we communicate via Slack. There are several Slack channels - a housing-insights channel as well as a channel for each team (data, D3, and prototype).
In addition to Slack, we also use the Github Issues to discuss things related to specific new features or updates. As a contributor to the project, please use issues frequently!
On Waffle, use the ‘In Progress’ section to indicate something is actively being worked on, so others shouldn’t duplicate your work.
On Waffle, use the ‘Coordination needed’ section to flag something to discuss at the next meeting.
Use the ‘assign’ function to indicate who is working on what. You can always assign yourself. If you assign an issue to someone else, be sure to talk to them about it (via Slack or in person). If you stop working on an issue, unassign yourself. We want the assignees to accurately reflect what is available and what isn’t.
Are you working on something that isn’t listed? Add a new issue for it so that we can keep track!
See something we should do in the future? Add a new issue for it!