From e31f39718f38149cd1a2d00aad4073d612e4526d Mon Sep 17 00:00:00 2001 From: Giancarlo Buenaflor Date: Wed, 13 May 2026 19:12:53 +0200 Subject: [PATCH] docs(repo): Add branch naming guidance Document the preferred branch name format so contributors use a consistent username/type/description structure. Co-Authored-By: GPT-5.5 Co-authored-by: Cursor --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0508e7a212..3cbd208ed1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -98,6 +98,16 @@ automatically: Only packages with staged changes are analyzed — no need to wait for the full monorepo. +## Branch Naming + +Use the format `git-username/type/short-description` for branch names. + +* `git-username` should match your Git username or GitHub handle. +* `type` should be a conventional change type such as `feat`, `fix`, `docs`, `test`, or `chore`. +* `short-description` should be lowercase, hyphen-separated, and describe the change. + +For example: `octocat/feat/add-http-timeout`. + ## Changelog Changelogs are generated automatically during the release process using