Git Usage Guide - JanAsaulenko/coworking GitHub Wiki

Git Usage Guide

Naming branches

We name our branches like this: jd/bug/LL-777-fix-user-avatar, where:

  1. jd/ - your initials abbreviation (for John Doe it is jd/, for Andrew Wheeler - aw/).
  2. bug/ - type of the corresponding story; can be only bug/ or task/ ("subtask" is a "task" too, except that fact it is under some user story ticket).
  3. fix-user-avatar - shortest description what your branch is about.
  4. LL-777 - story ID.

No other special characters are allowed, except / and - for separating words.

Naming pull-requests

We name our pull requests like this: [LL-777] Fix user avatar URL in API responses for frontend, where:

  1. [LL-777] - points out corresponding story.
  2. Fix user avatar URL in API responses for frontend - short readable description about the purpose of the pull-request.
  3. PR's description should include a link to a story.

Naming commits

We name our commits like this: [LL-777] Fix user avatar URL in API response, where:

  1. [LL-777] - points out corresponding story.
  2. Fix user avatar URL in API response - shortest commit title, that represents sense of the changes done. It is HIGHLY RECOMMENDED to follow this guide for naming your commits - https://chris.beams.io/posts/git-commit/