Use these names for your Git branches.
Topic branches
Use the format user/issue/topic.
| Part | Meaning | Example | Optional |
|---|---|---|---|
| user | Your GitHub username | rvl | If branch is a shared effort and issue is provided. |
| issue | Jira issue key or GitHub issue number | ADP-123, 1234 | If username and/or issue are provided. |
| topic | Some description of the branch | add-foo | If issue is provided. |
Release branches
We release from the mainline branch, and therefore don’t use release branches.
This lowers maintenance overheads, but requires that we always keep master in a releaseable state.
Release preparation branches
According to the Release Checklist, these are of the form your-name/bump-release/YYYY-MM-DD.
Mainline branch
Mainline branch is master - for consistency.