forked from vincent/notebook
add Commit convention
This commit is contained in:
parent
70747a9f17
commit
55314752d8
43
IT/Git/Commit.md
Normal file
43
IT/Git/Commit.md
Normal file
@ -0,0 +1,43 @@
|
|||||||
|
# Commit Convention
|
||||||
|
|
||||||
|
To be more readable you can use following commit procedure
|
||||||
|
|
||||||
|
```
|
||||||
|
<type>[optional scope]: <description>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<footer>
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## Type
|
||||||
|
|
||||||
|
- build: modify script build (MakeFile or other)
|
||||||
|
- chore: updatating grunt task
|
||||||
|
- ci: Continual Integration change
|
||||||
|
- docs: documentation changes
|
||||||
|
- feat: new feature for the user,
|
||||||
|
- fix: bug fix for the user
|
||||||
|
- perf: performance improvment
|
||||||
|
- refactor: refactoring code
|
||||||
|
- style: formatting change
|
||||||
|
- test: test modification
|
||||||
|
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
Example of scope:
|
||||||
|
|
||||||
|
- name of job
|
||||||
|
- logger
|
||||||
|
- init
|
||||||
|
- runner
|
||||||
|
- config
|
||||||
|
- etc...
|
||||||
|
|
||||||
|
|
||||||
|
## footer
|
||||||
|
|
||||||
|
Can reference closed issue and breaking changes
|
Loading…
Reference in New Issue
Block a user