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:
jd/
- your initials abbreviation (for John Doe it isjd/
, for Andrew Wheeler -aw/
).bug/
- type of the corresponding story; can be onlybug/
ortask/
("subtask" is a "task" too, except that fact it is under some user story ticket).fix-user-avatar
- shortest description what your branch is about.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:
[LL-777]
- points out corresponding story.Fix user avatar URL in API responses for frontend
- short readable description about the purpose of the pull-request.- 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:
[LL-777]
- points out corresponding story.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/