> A good [[commit message]] should clearly describe what changes were made and why.
This [[Version control principle|principle]] helps in understanding the project history and makes it easier for others (and your future self!) to follow along.
## Example
### Bad
```md
CR fixes done
```
It actaully explains nothing:
1. if you need to determine what has been changed, you need to track the original CR (probably unknown)
2. and moreover if you would like to revert certain changes, you are unable as there are others as well.
### Good
```md
Fix typo in introduction to user guide
```
Way better, as
- it explains what it is about
- and is [[Atomic Commits|atomic]], so reversable if needed