During my first two years as a professional engineer, I wrote commits that looked like this:
feat: build core payment feature
fix: broken links
Yes, they were honest. They shipped. But as you move beyond the MVP stage and begin scaling the product, this development style fails.
When your team grows, or when stakeholders (CEOs, investors, and auditors) start asking for the why behind a pivot made six months ago, "broken links" isn't a valid answer, but a liability.
If you find yourself spending more time in Slack threads and outdated Notion pages than actually building, your documentation needs more work. Git is the documentation 99% of the time.
Warning
For an internal tool, a prototype, or a data pipeline that only two people touch, fix: broken links is fine. Not every repo needs FAANG commit discipline. I'm only speaking for teams that suffer from micromanagement, big organizations, and consultants who need to document their work.
As a rule of thumb: If the project is supervised by stakeholders and needs to be maintained over time, be disciplined with the commits.
Git is the Product Documentation
If you are documenting code trade-offs or implementation details in external tools, your process needs to improve. Of course, major architecture choices and business-level details should be in separate documents or runbooks.
Git is the only source of truth. It is the only artifact that is guaranteed to be version-synced with the code.
Machines read your Commit History nowadays. AI agents, automated changelog parsers, and technical auditors will eventually be responsible for reviewing your work. Structure it for them.
1. Implement Commit Scoping
Generic commits are just fine. Scoped commits create a map and logical structure when using commands like git log --grep.Β
By using a convention like Conventional Commits, you provide immediate context.
Bad: feat: add Stripe support
Better: feat(payments): add Stripe integration for subscription billing
Fix: fix(payments): add missing idempotency key in Stripe webhook
This allows any developer to filter the history and instantly see every change that ever touched the payment gateway.
2. Work Well with Pull Requests
A Pull Request (PR) shouldn't be a code dump; it should be a story. Here are my recommendations:
- Keep PRs under 200-300 lines.
- Explain the business intent, not just the technical how.
- Attach images, videos, or terminal output to prove it works.
- Link the specific issue or ticket number (#125) in the title. This creates a bi-directional link between your task management and your code.
- Use draft mode for work-in-progress.
- Review your own PR first before assigning.
- Reply to comments, push fixup commits, then squash with discipline.
3. The Power of the Commit Body
Most engineers treat the commit message like a text message; short and rushed. This is where you lose the most value. For major features or complex refactors, utilize the commit body.
Example:
feat(payments): implement PayPal strategy in Payment Gateway
- Added PayPal to PaymentService strategy pattern implementation.
- Extended PaymentService test suite to cover multi-provider edge cases.
- Implemented Circuit Breaker pattern to handle PayPal API downtime.
Note: This was a priority request from the sales team to unblock the European market expansion.
Yes, this level of detail is overkill for a typo fix, but it is mandatory for architectural shifts and major features. It documents the artifacts used and the technical trade-offs made at the moment.
4. Leverage Branches
Branches are isolated environments that allow a team to work on ten different features without stepping on each other's toes.
The main rule is to never commit directly to
main.mainis sacred, as it represents the version of the product that is currently making the company money.Name your branches to match your intent.
feat/payments-paypalorfix/auth-login-looptells your team exactly what is happening before they even open the code.When you name a branch after a ticket number (e.g.,
feature/PROJECT-123), you create a permanent link between business and engineering.
Conclusion
Git is more than just a place to save your code; itβs the memory of your product.
By being disciplined with your commits and PRs, you stop wasting time in Slack and Notion.
With a clear Git history, you create a system that a new developer, a CEO, or an AI can understand the logic behind the software.
I'm also working on a product called Fabric, which turns your GitHub commits into reports for non-technical managers. You can learn more about it here: https://github.com/franciscoluna-28/fabric-ai.
Top comments (0)