Add chapter about GIT in the README.md

mediamonks / frontend-coding-standards

Media.Monks - Frontend Coding Standards

60 stars 23 forks source link

Add chapter about GIT in the README.md #2

Closed ThijsTyZ closed 3 years ago

ThaNarie commented 4 years ago

When sharing info between issues and code, I like to do the following:

start the branch with the issue key (feature/OF-938-name-of-the-ticket)
use the same issue key at the start of the commit message (OF-938 Implement feature abc)

The branch name is useful for integrations, and helps with autocomplete.

The issue key is useful if you look at the commit log (which mostly only shows the first line)

skulptur commented 4 years ago

Regarding prefixing the commits, I would say it's only reliable if we can automate it. Even trying my best to pay attention to this I still made commits with the wrong number every now and then. If this is a manual process it will happen.

skulptur commented 4 years ago

Also consider using a linter for the commit messages: https://commitlint.io/

how to: https://remarkablemark.org/blog/2019/05/29/git-husky-commitlint/