Git Branch Naming

Main Branch

We prefer "main" for the main branch. For background, see:

• Regarding Git and Branch Naming - Software Freedom Conservancy
• github/renaming: Guidance for changing the default branch name for GitHub repositories
• The default branch for newly-created repositories is now main | GitHub Changelog

Branching Models

• GitFlow
• GitHub flow

We currently use this structure; we use "work branches" (similar to "feature" branches) to make proposed changes, and they get merged by someone else to main.

• main
  • work branches

Branch Naming

We typically name work branches with three components:

• identifier of the lead on the changes (usually, two or three initials)
• short name of the gist of the work (keep it very short, e.g., 10 characters)
• date in YYYYMMDD format

Examples:

• jrs-traction-2022-07-19
• pk-expanding-system-design-2022-07-19