Skip to content

GitHub Best Practices

Collaborative Development

...or “If it is not in GitHub, it does not exist!”

While you may spend a significant amount of time and energy building a model or system from scratch, the ownership of the code base is our team’s collective ownership, not the individual developer. You may act today as both the engineer of a system as well as its maintainer, addressing bugs and data issues reported by downstream consumers, but remember that all of us are likely to work on something else eventually and someone else will step into the shoes of the maintainer for the system you have built.

All our work should be under source control in GitHub; “if it isn’t in GitHub, it doesn’t exist!” Contributing to a repository should follow the standard open-source contribution process:

  1. Develop on a branch from master
  2. Pull request those changes to master
  3. Have code reviewed and request approved
  4. Merge pull request and delete the branch

It is all of our responsibility to review each other’s code. All code we produce should be properly documented and written according to best practices.

See below for our GitHub organization:

specialolympics

See below for the repo for this documentation site:

Repo