README.md

Git

Git conventions

1. Conventional Commits
   • Git Commit Msg
2. Use the imperative mood in the subject line

A quick look at some of the main points:

1. MUST type, subject and footer
2. SHOULD scope
3. MUST use footer for reference (eg. ticket id) ; MUST NOT use scope for reference
4. SHOULD use markdown link format in case of no GitLab integration (eg. generated URL link)

Examples:

# Wrong type & bad desc (past tense)
- fix(button): initiated component …
+ feat(button): init component …

# Ref & bad desc
- fix(FOO-666): fix rule
+ fix(auth): add required oauth 2 configuration
+ 
+ Refs: [FOO-666](https://…/FOO-666)

Git internal config

1. .gitignore (MUST)
2. .gitattributes (SHOULD)

Git helpers

1. Commitlint (MUST)
   1. Config
2. Husky (MUST)
   1. Config
   2. eg. .husky/{pre-commit | pre-push…}
3. Commitizen (SHOULD)
   1. Config