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