NiN

Git Commit Rule

5/6/2021 Git

# Structure:

# []: optional, <>: required
<type>[optional scope]: <description>

[optional body]

[optional footer(s)]
1
2
3
4
5
6

# Main

# 1. Type

fix
feat
refactor
docs
style
perl: performance Optimize
vendor: up/down-grade version
chore
1
2
3
4
5
6
7
8

# 2. Scope

Scope in source

# Body

Multiline with blank line

  • Review
  • Link/ID Pull request, commit

# BREAKING CHANGE

For big update/change code

# 1. !

fix!: remove module A
1

# 2. BREAKING CHANGE Footer

fix!: remove module A

BREAKING CHANGE: remove module A and replace it with module B
1
2
3

# Sample

feat(auth): implement login function.

see the document for details

Reviewed-by: A
Refs #123
1
2
3
4
5
6