Version control is a project's best source of documentation when done correctly. When trying to understand code it's extremely useful to use git blame
to find both the PR and the issue associated with that change.
PRs should be small and focused. Each commit should solve a single problem and be covered by a test that exemplifies that particular feature or fix.
All PRs must be reviewed by a teammate before they are eligle to be merged into the master
branch. Large PRs are difficult to review. Be sure to break large PRs into smaller ones so that they can be reviewed quickly and deployed to production.
- Never commit passwords, access tokens, or other credentials into version control. If you think you absolutely have to, ask first. If you do this by accident, tell someone immediately.
- Each commit should be as small and as simple as possible.