From 8bb19728fd47d2bbe890e92a50b21773bd5db64b Mon Sep 17 00:00:00 2001 From: Paul Menzel Date: Thu, 17 Nov 2016 15:14:44 +0100 Subject: [PATCH] Documentation: Clarify commit message summary format --- Documenation/SubmittingPatches | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/Documenation/SubmittingPatches b/Documenation/SubmittingPatches index 3625600f0..fb61e3459 100644 --- a/Documenation/SubmittingPatches +++ b/Documenation/SubmittingPatches @@ -95,11 +95,15 @@ run git diff --check on your changes before you commit. The first line of the commit message should be a short description (50 characters is the soft limit, see DISCUSSION in git-commit(1)), and should skip the full stop. It is also conventional in most cases to -prefix the first line with "area: " where the area is a filename or -identifier for the general area of the code being modified, e.g. +prefix the first line with "project: " where the project is a filename +or identifier for the project, the Bee file is for, e.g. - . archive: ustar header checksum is computed unsigned - . git-cherry-pick.txt: clarify the use of revision range notation + . vlc: Enable awesome feature + . linux-4.9-rc5: Add a patch + +The description is a summary, and should be a statement, that means, it +has to contain a verb. Best, start the statement with a verb in +imperative mood. If in doubt which identifier to use, run "git log --no-merges" on the files you are modifying to see the current conventions.