Conventional Branch Specification – Open‑Source Project Announcement and Guidelines

What is the Conventional Branch Specification

The Conventional Branch Specification defines a structured and standardized naming convention for Git branches to improve readability and operability, offering suggested prefixes while allowing custom conventions; consistent naming makes it easier to identify branch types.

Specification

Branch prefixes such as feature/ , bugfix/ , hotfix/ , release/ and chore/ are used, and the structure should follow:

<type>/<description>

main : primary development branch (e.g., main , master , develop )

feature/ : new features (e.g., feature/add-login-page )

bugfix/ : bug fixes (e.g., bugfix/fix-header-bug )

hotfix/ : urgent fixes (e.g., hotfix/security-patch )

release/ : preparation for release (e.g., release/v1.2.0 )

chore/ : non‑code tasks like dependency updates (e.g., chore/update-dependencies )

Key Points

Purpose‑driven branch names : each name clearly indicates its purpose, allowing developers to understand the branch’s intent at a glance.

CI/CD integration : consistent names enable automation pipelines to trigger specific actions based on branch type.

Team collaboration : clear naming reduces misunderstandings and eases task switching, fostering better teamwork.

Benefits

Clear communication : branch names convey usage without digging into code.

Automation‑friendly : easy to hook into workflows for features, releases, etc.

Scalability : works well for large teams handling many concurrent tasks.

In summary, the Conventional Branch Naming aims to improve project organization, communication, and automation within Git workflows.

FAQ

Which tools can automatically check compliance with this specification?

You can use commit-check [1] or commit-check-action [2] if your repository is hosted on GitHub.

Conclusion

Inspired by the Conventional Commits specification, we are excited to launch this open‑source project. Currently only an English version is available, with plans for additional languages. Contributions are welcome via the issues page.

Thank you for your attention – please star and share the project.

References

[1] commit-check: https://github.com/commit-check/commit-check

[2] commit-check-action: https://github.com/commit-check/commit-check-action

[3] issues: https://github.com/conventional-branch/conventional-branch/issues