Github

GitHub Best Practices

Starting a repo for a DSWG project

• Make sure the name for your repo is prefaced with datasci-. This helps newcomers to the Data Science Working Group find projects they might be interested in.
• Add a README.md to your repo! See the datasci-congressional-data group as an example.
• If you are not a member of the sfbrigade github group, you will have to join.

Workflow

The Feature Branch Workflow is pretty great.

Branch naming conventions

Name your branches according to Github issue numbers.

example:

• There is an issue open on Github switch to css grid layout #76
• I should name my branch that fixes this issue something like 76-switch-to-css-grid

This way, when other team members see your branch, they can see exactly what issue which branch addresses.