2022-11-29 17:24:56 +00:00
|
|
|
# Commit Convention
|
|
|
|
|
|
2022-11-29 17:26:31 +00:00
|
|
|
To be more readable you can use following commit procedure
|
2022-11-29 17:24:56 +00:00
|
|
|
|
2022-11-29 17:26:31 +00:00
|
|
|
```commit
|
2022-11-29 17:24:56 +00:00
|
|
|
<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
|
