mirror of
https://gitea.com/mcereda/oam.git
synced 2026-02-10 06:04:24 +00:00
29 lines
518 B
Markdown
29 lines
518 B
Markdown
# Conventional commits
|
|
|
|
Lightweight convention on top of commit messages.<br/>
|
|
It provides an easy set of rules for creating an explicit commit history.
|
|
|
|
## Table of contents <!-- omit in toc -->
|
|
|
|
1. [TL;DR](#tldr)
|
|
1. [Further readings](#further-readings)
|
|
|
|
## TL;DR
|
|
|
|
A commit message should be structured as follows:
|
|
|
|
```txt
|
|
<type>[optional scope]: <description>
|
|
|
|
[optional body]
|
|
|
|
[optional footer(s)]
|
|
```
|
|
|
|
## Further readings
|
|
|
|
- [Website]
|
|
|
|
<!-- project's references -->
|
|
[website]: https://www.conventionalcommits.org
|