github/capsule
1
0
Fork 0
mirror of https://github.com/projectcapsule/capsule.git synced 2026-08-25 16:07:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: documenting the Conventional git Commit Messages

Browse Source
This commit is contained in:
bsctl
2021-08-19 13:03:10 +02:00
committed by Dario Tranchitella
parent 6393541818
commit 23e55c685c
1 changed files with 1 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/operator/contributing.md
+1 -2
View File
@@ -242,8 +242,7 @@ A commit description is welcomed to explain more the changes: just ensure
to put a blank line and an arbitrary number of maximum 72 characters long
lines, at most one blank line between them.
Please, split changes into several and documented small commits: this will help
us to perform a better review.
Please, split changes into several and documented small commits: this will help us to perform a better review. Commits must follow the the Conventional Commits Specification, a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with Semantic Versioning, by describing the features, fixes, and breaking changes made in commit messages. See [Conventional Commits Specification](https://www.conventionalcommits.org) to learn about Conventional Commits.
> In case of errors or need of changes to previous commits,
> fix them squashing to make changes atomic.