From 33027941cf09f4ecaa3ab4d64186b616841d5545 Mon Sep 17 00:00:00 2001 From: Henry Wurzburg Date: Sat, 21 Sep 2024 06:39:09 -0500 Subject: [PATCH] modify notes on commit squashing --- dev/source/docs/submitting-patches-back-to-master.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev/source/docs/submitting-patches-back-to-master.rst b/dev/source/docs/submitting-patches-back-to-master.rst index 6fc514c05b..b7c0663b1b 100644 --- a/dev/source/docs/submitting-patches-back-to-master.rst +++ b/dev/source/docs/submitting-patches-back-to-master.rst @@ -51,7 +51,7 @@ Preparing commits to `online resources `__ to understand how to use this tool. -- The commits of the change should be squashed (see :ref:`git-interactive-rebase`) into one commit and then the "Tools/gittools/git-subsystems-split" script run to create a single commit for each library module affected. +- Each commit should involve only a single library. The commits of the changes in each library should be squashed (see :ref:`git-interactive-rebase`) into the minimal number of commits per library that allows readability and clarity when reviewing (usually only one commit). The "Tools/gittools/git-subsystems-split" script can be run on any commit spanning multiple libraries to create a single commit for each library module affected before submitting. if needed. - Do not submit patches with commented-out code or code that is never reachable within ``#define`` s.