I use the following convention:
type: subject
body
The goal of this convention is to communicate clear goal.
The types are based on our GitHub label:
fix– When fixing an issue.chore– When doing some cleanup, working on tooling, some refactoring.doc– When writing documentation.feat– When working on a feature.
The subject of a commit should be a summary of what the commit is about. It should not describe what the code is doing:
feat: what the feature isfix: what the problem ischore: what the PR is aboutdoc: what is documented
Examples:
feat: introduce combobox primitivefix: popover is not correctly alignedchore: refactor checkbox to use radixdoc: update storybook for button
⚠️ For afixcommit the message should explain what the commit is fixing. Not what the solution is.
Use kebab-case to name your branches: prefix/branch-name-something
Branch naming convention
fix: When fixing an issue:fix/some-bugchore: When doing some cleanup, working on tooling, some refactoring:chore/code-refactoringdocs: When writing documentation:doc/documentation-subjectfeat: When you are working on a feature. Start by creating afeat/name-of-featurebranch & create tasks branches with the feature name as prefix: