From 843427dd691811773156e23b9011f269f4c370f3 Mon Sep 17 00:00:00 2001 From: Donatas Abraitis Date: Tue, 31 Jan 2023 10:59:01 +0200 Subject: [PATCH] doc: Write a short introduction about squashing commits Signed-off-by: Donatas Abraitis --- doc/developer/workflow.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/doc/developer/workflow.rst b/doc/developer/workflow.rst index 06a2ccbc0a..88ee358384 100644 --- a/doc/developer/workflow.rst +++ b/doc/developer/workflow.rst @@ -342,6 +342,19 @@ summary of the included patches. The description should provide additional details that will help the reviewer to understand the context of the included patches. +Squash commits +-------------- + +Before merging make sure a PR has squashed the following kinds of commits: + +- Fixes/review feedback +- Typos +- Merges and rebases +- Work in progress + +This helps to automatically generate human-readable changelog messages. + + .. _license-for-contributions: License for Contributions -- 2.39.5