- Notifications
You must be signed in to change notification settings - Fork0
unifiedbits/commit-guidelines
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Welcome to the official commit convention guide for UnifiedBits!
We follow theConventional Commits specification to ensure clarity, traceability, and automation in our development process.
- 🧠 Clear project history
- 🚀 Easy changelog generation
- 🤖 Enables automation (versioning, deployments)
- 🤝 Improves team collaboration and onboarding
A commit message must be structured as follows:
<type>(optional scope): <short summary>[optional body][optional footer]feat(auth): add login with OTP supportThis introduces OTP-based authentication using Twilio.Also updates the user model to include phone verification.Fixes #24| Type | Description |
|---|---|
feat | A new feature |
fix | A bug fix |
docs | Documentation only changes |
style | Code style changes (formatting, missing semicolons, etc.) |
refactor | Code change that neither fixes a bug nor adds a feature |
perf | Performance improvements |
test | Adding or updating tests |
chore | Maintenance tasks (configs, deps, CI/CD) |
Usescopes to specify which part of the codebase is affected.
Example:feat(api),fix(ui),docs(readme)
| Scope Examples |
|---|
auth |
ui |
api |
core |
docs |
deps |
- ✅ Use theimperative mood: "fix bug" not "fixed bug"
- ✅ Keep subject line under72 characters
- ✅ Use body to explainwhy, not justwhat
- ✅ Separate thesubject,body, andfooter with blank lines
- ✅ Reference issues or PRs in the footer (e.g.,
Fixes #12)
Here are realistic examples categorized by type:
feat(auth): add login with OTP supportfeat(dashboard): implement user analytics chartsfeat(api): add endpoint for bulk file processingfix(ui): resolve button misalignment on mobile viewfix(api): correct 500 error on invalid inputfix(auth): prevent token from expiring prematurelydocs(readme): update installation instructionsdocs(api): add usage examples to user routesdocs(contributing): explain branching strategystyle(ui): unify font sizes across componentsstyle(css): apply consistent padding and marginsstyle(auth): fix lint warnings and spacing issuesrefactor(core): extract utility functions from controllerrefactor(api): simplify query logic in search routerefactor(auth): remove unused middlewareperf(api): optimize DB query for loading dashboardperf(ui): lazy load images for faster initial loadtest(api): add test cases for file uploadtest(auth): increase test coverage for login flowtest(ui): snapshot tests for new componentschore(ci): add GitHub Actions workflow for testingchore(deps): upgrade dependencies to latest versionschore(project): rename folders for clarity- 🛡️Commitlint – Lint commit messages
- 🤖Commitizen – Generate commits via CLI prompts
- 📦Semantic Release – Automate changelog and versioning
Following a convention for commit messages ensures every contributor understands the codebase history clearly, automates release processes, and scales the team with confidence.
“Quality is never an accident; it is always the result of intelligent effort.” – John Ruskin
Happy committing! 🚀
— TeamUnifiedBits
About
A comprehensive guide to Conventional Commits for developers — ensuring clean, consistent, and automated commit practices across all projects.
Topics
Resources
Uh oh!
There was an error while loading.Please reload this page.