mirror of
https://gitea.com/mcereda/oam.git
synced 2026-02-09 05:44:23 +00:00
chore: added article for conventional commits and started using them
This commit is contained in:
28
knowledge base/conventional commits.md
Normal file
28
knowledge base/conventional commits.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# 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:
|
||||
|
||||
```text
|
||||
<type>[optional scope]: <description>
|
||||
|
||||
[optional body]
|
||||
|
||||
[optional footer(s)]
|
||||
```
|
||||
|
||||
## Further readings
|
||||
|
||||
- [Website]
|
||||
|
||||
<!-- project's references -->
|
||||
[website]: https://www.conventionalcommits.org
|
||||
Reference in New Issue
Block a user