๐ฟConventional Commits & Git Branch Generator Documentation & Guide
๐Constructing Standardized Semantic Commits & Branches
- Select Commit Type & Scope: Choose a standardized type ('feat', 'fix', 'refactor', 'perf', 'docs', 'test', 'build', 'ci', 'chore') and an optional contextual scope (e.g., 'auth', 'api', 'ui').
- Add Subject Description: Write a concise, imperative subject line describing what was changed (e.g., 'implement Web Crypto signing for HS256 tokens').
- Configure Breaking Changes & References: Check the Breaking Change toggle if the modification introduces backward-incompatible changes, and attach optional ticket or issue numbers (e.g., 'MOT-310').
- Copy Ready-to-Run Git Commands: Click 'Generate Commit & Branch' (or press Ctrl + Enter) to copy formatted multiline commit messages and direct CLI commands (`git checkout -b` and `git commit -m`).
โ๏ธConventional Commits v1.0.0 & Automated Release Pipelines
The Conventional Commits specification creates an explicit commit history that lightweight automated tooling can parse to automatically determine Semantic Versioning increments and generate accurate changelogs.
Adheres strictly to the Conventional Commits 1.0.0 specification and pairs with automated changelog tools like release-please and standard-version.
๐กEngineering Team Workflows
- Automated CI/CD Versioning: Trigger automatic Semantic Versioning and GitHub Release generation via GitHub Actions on branch merge.
- Clear Pull Request Reviews: Give reviewers immediate clarity on the nature and blast radius of incoming changes directly from the PR title and commits.
- Clean Git Archeology: Enable fast bisecting, cherry-picking, and historical search across repositories with thousands of commits.