Skip to content

Overview of git branches and PR title naming conventions

Here's an overview of our core git process for producing an article. It might have variations depending on project specifics, but all else being equal this is generally what should happen.

Naming conventions

  • Draft branch name draft-how-to-foo-with-bar, PR title draft: How to Foo with Bar
  • QA branch name qa-how-to-foo-with-bar, PR title qa: How to Foo with Bar
  • Editing branch name edit-how-to-foo-with-bar, PR title edit: How to Foo with Bar
  • Revisions branch name revise-how-to-foo-with-bar, PR title revise: How to Foo with Bar

Merge order

Normally

  • Writer will open Draft PR
  • QA will open and merge QA PR into Draft
  • Editor will open and merge Edit PR into Draft
  • Editor will share the draft branch with ritza-deliver tag, and ask writer to confirm all changes (QA and Edit) are OK.