From 4e1a2aff47063c233fa0244d052d72fc4febc9d1 Mon Sep 17 00:00:00 2001 From: Riku Isokoski Date: Sun, 29 Jan 2023 18:19:43 +0200 Subject: [PATCH] contribute.md: Add commit format section Inspired by: https://www.klipper3d.org/CONTRIBUTING.html#format-of-commit-messages --- doc/contribute.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/doc/contribute.md b/doc/contribute.md index 49792583..d3b33aa7 100644 --- a/doc/contribute.md +++ b/doc/contribute.md @@ -45,3 +45,17 @@ for what maintainers will look at in PRs. - Commits that fix mistakes from previous commits must be squashed - Conflicts must be resolved by rebasing, instead of merging + +### Commit format + +The preferred format for commits is the following: + +``` +module: Short description + +A more thorough description of all changes in this commit if necessary. +``` + +where module can be the name of the file, +with or without extension, +or a single word explaining the scope of the changes.