Skip to main content

How We Git

Repository Management​

Required Files​

README.md​

Always located in the repository root. It can consist of a simple structure or include more complex explanation of how to run the project. Things to document in a README:

  • Makefile targets
  • npm/yarn scripts
  • Local troubleshooting

If a README become too long, it's best to break it out into docs folder.

CODEOWNERS​

Typically located in the repository root or at .github/CODEOWNERS. Used for the purpose of automatically assigning engineers who designated themselves as codeowners on a project to review a PR.

Read more about using a CODEOWNERS file

Branching Workflows​

This varies from project to project and should be documented within the repository's README.md or docs folder but we typically follow either of these workflows: