There's a lot of advice on git best practices. They all sound nice in theory, but how do we meet these best practices without slowing ourselves down?
This repo is meant as a demonstration of common git workflow challenges
• Don't commit incomplete or broken work - ensure code builds and tests pass • Make focused commits that represent a single, logical change • Write clear, descriptive commit messages that explain the "why" not just the "what" • Keep pull requests small and reviewable - break down large changes into smaller PRs or use stacking • Use meaningful branch names that describe the feature or fix • Pull/rebase frequently to stay up-to-date with main branch • Squash or clean up messy commit history before merging
- Checkout the
all-changesbranch - Make test setup and counter refactor into a stacked PR
- Squash the Refactor and WIP commits into one commit
- Pull the license change out into a completely separate PR
- Resolve conflicts with main