Lesson 3 of 5
Commit Best Practices
Why Good Commit Messages Matter
A clean commit history is essential for collaboration. At our company, every commit should tell a story — what changed, why it changed, and what impact it has.
Our Commit Message Format
type(scope): short description (max 72 chars)
Body: explain what and why, not how.
Ref: JIRA-1234
Body: explain what and why, not how.
Ref: JIRA-1234
Commit Types We Use
feat
New feature
fix
Bug fix
docs
Documentation change
refactor
Code restructuring
Tip
Keep your commits small and focused — one logical change per commit makes code reviews faster and rollbacks painless.
Warning
Never commit directly to main or develop. All changes must go through a pull request, even small hotfixes.
Don't do this
Avoid vague messages like "fix stuff", "wip", or "changes". They make the history unreadable and will be flagged in code review.
Info
Our CI pipeline runs lint and tests on every push. A broken commit will block your PR from merging — check locally with npm run check before pushing.
Quiz · Lesson 3
Commit Practices Check
08:42
QUESTION 1 OF 3
Which commit type should be used when fixing a bug that was causing production issues?
feat — it's a new behaviour
fix — it addresses a bug
hotfix — special type for production
chore — maintenance work
🎯
Quiz Complete!
2/3
Score: 67% — keep it up!
Admins can see this result as part of your onboarding progress.