Many commit message bodies start off with some background information, before explaining how they address the situation. This can be arguably easier to follow than having the imperative in the commit message title be followed directly by another differently worded or more verbose imperative in the commit message body and then at the end an ", because ..." with an explanation why things were done this way. Yet, while the documentation talks about use of imperative mood, it does not fully explain why, which IMO makes it prone to misunderstanding[1][2]. Therefore adapt the documentation to clarify the intent of the imperative mood and give an example for how a good commit message can look like. [1]: https://lore.kernel.org/all/f085aa33-f0b7-49e7-bbfc-d3728d3e3e8c@xxxxxxxxxxxxxx/#t [2]: https://lore.kernel.org/all/Z2RzA5S%2Fch1YDdUD@lizhi-Precision-Tower-5810/ --- Ahmad Fatoum (2): docs: process: submitting-patches: split canonical patch format section docs: process: submitting-patches: clarify imperative mood suggestion Documentation/process/submitting-patches.rst | 74 +++++++++++++++++++--------- 1 file changed, 52 insertions(+), 22 deletions(-) --- base-commit: 78d4f34e2115b517bcbfe7ec0d018bbbb6f9b0b8 change-id: 20241219-submitting-patches-imperative-248413781db1 Best regards, -- Ahmad Fatoum <a.fatoum@xxxxxxxxxxxxxx>
