Skip to content

Commit

Permalink
Documentation: Clarify commit message summary format
Browse files Browse the repository at this point in the history
  • Loading branch information
pmenzel committed Nov 17, 2016
1 parent 5828d92 commit 8bb1972
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions Documenation/SubmittingPatches
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 8bb1972

Please sign in to comment.