From: Adam Spiers <git@adamspiers.org>
To: git list <git@vger.kernel.org>
Subject: [PATCH 1/3] SubmittingPatches: add convention of prefixing commit messages
Date: Sun, 16 Dec 2012 19:35:59 +0000 [thread overview]
Message-ID: <1355686561-1057-2-git-send-email-git@adamspiers.org> (raw)
In-Reply-To: <1355686561-1057-1-git-send-email-git@adamspiers.org>
Conscientious newcomers to git development will read SubmittingPatches
and CodingGuidelines, but could easily miss the convention of
prefixing commit messages with a single word identifying the file
or area the commit touches.
Signed-off-by: Adam Spiers <git@adamspiers.org>
---
Documentation/SubmittingPatches | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 0dbf2c9..c107cb1 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -9,6 +9,14 @@ Checklist (and a short version for the impatient):
- 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.
+ . archive: ustar header checksum is computed unsigned
+ . git-cherry-pick.txt: clarify the use of revision range notation
+ (if in doubt which identifier to use, run "git log --no-merges"
+ on the files you are modifying to see the current conventions)
- the body should provide a meaningful commit message, which:
. explains the problem the change tries to solve, iow, what
is wrong with the current code without the change.
--
1.7.12.1.396.g53b3ea9
next prev parent reply other threads:[~2012-12-16 19:36 UTC|newest]
Thread overview: 90+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-09-02 0:12 [PATCH 0/9] new git check-ignore sub-command Adam Spiers
2012-09-02 0:12 ` [PATCH 1/9] Update directory listing API doc to match code Adam Spiers
2012-09-02 0:12 ` [PATCH 2/9] Improve documentation and comments regarding directory traversal API Adam Spiers
2012-09-02 0:12 ` [PATCH 3/9] Rename cryptic 'which' variable to more consistent name Adam Spiers
2012-09-02 19:56 ` Junio C Hamano
2012-09-02 0:12 ` [PATCH 4/9] Refactor excluded_from_list Adam Spiers
2012-09-04 12:32 ` Nguyen Thai Ngoc Duy
2012-09-02 0:12 ` [PATCH 5/9] Refactor excluded and path_excluded Adam Spiers
2012-09-04 12:40 ` Nguyen Thai Ngoc Duy
2012-09-04 17:23 ` Junio C Hamano
2012-09-05 10:28 ` Nguyen Thai Ngoc Duy
2012-09-06 3:21 ` Junio C Hamano
2012-09-06 12:13 ` Nguyen Thai Ngoc Duy
2012-09-06 14:59 ` Thiago Farina
2012-09-06 15:05 ` Nguyen Thai Ngoc Duy
2012-09-06 17:42 ` Adam Spiers
2012-09-06 21:07 ` Junio C Hamano
2012-09-02 0:12 ` [PATCH 6/9] For each exclude pattern, store information about where it came from Adam Spiers
2012-09-02 17:00 ` Philip Oakley
2012-09-02 19:02 ` Junio C Hamano
2012-09-02 22:36 ` Philip Oakley
2012-09-06 17:56 ` Adam Spiers
2012-09-02 0:12 ` [PATCH 7/9] Extract some useful pathspec handling code from builtin/add.c into a library Adam Spiers
2012-09-02 0:12 ` [PATCH 8/9] Provide free_directory() for reclaiming dir_struct memory Adam Spiers
2012-09-02 0:12 ` [PATCH 9/9] Add git-check-ignores Adam Spiers
2012-09-02 10:41 ` Nguyen Thai Ngoc Duy
2012-09-02 14:50 ` Adam Spiers
2012-09-02 20:38 ` Junio C Hamano
2012-09-03 4:14 ` Nguyen Thai Ngoc Duy
2012-09-02 20:41 ` Junio C Hamano
2012-09-03 1:47 ` Junio C Hamano
2012-09-20 19:46 ` [PATCH v2 00/14] new git check-ignore sub-command Adam Spiers
2012-09-20 19:46 ` [PATCH v2 01/14] Update directory listing API doc to match code Adam Spiers
2012-09-20 19:46 ` [PATCH v2 02/14] Improve documentation and comments regarding directory traversal API Adam Spiers
2012-09-20 19:46 ` [PATCH v2 03/14] Rename cryptic 'which' variable to more consistent name Adam Spiers
2012-09-20 19:46 ` [PATCH v2 04/14] Rename path_excluded() to is_path_excluded() Adam Spiers
2012-09-20 19:46 ` [PATCH v2 05/14] Rename excluded_from_list() to is_excluded_from_list() Adam Spiers
2012-09-20 19:46 ` [PATCH v2 06/14] Rename excluded() to is_excluded() Adam Spiers
2012-09-20 19:46 ` [PATCH v2 07/14] Refactor is_excluded_from_list() Adam Spiers
2012-09-20 19:46 ` [PATCH v2 08/14] Refactor is_excluded() Adam Spiers
2012-09-20 19:46 ` [PATCH v2 09/14] Refactor is_path_excluded() Adam Spiers
2012-09-20 19:46 ` [PATCH v2 10/14] For each exclude pattern, store information about where it came from Adam Spiers
2012-09-20 21:31 ` Junio C Hamano
2012-12-26 15:46 ` Adam Spiers
2012-09-20 19:46 ` [PATCH v2 11/14] Refactor treat_gitlinks() Adam Spiers
2012-09-20 19:46 ` [PATCH v2 12/14] Extract some useful pathspec handling code from builtin/add.c into a library Adam Spiers
2012-09-21 7:54 ` Michael Haggerty
2012-09-20 19:46 ` [PATCH v2 13/14] Provide free_directory() for reclaiming dir_struct memory Adam Spiers
2012-09-21 8:03 ` Michael Haggerty
2012-09-21 16:11 ` Junio C Hamano
2012-09-20 19:46 ` [PATCH v2 14/14] Add git-check-ignore sub-command Adam Spiers
2012-09-21 5:44 ` Johannes Sixt
2012-09-25 23:25 ` Junio C Hamano
2012-09-26 5:49 ` Johannes Sixt
2012-09-26 14:03 ` Junio C Hamano
2012-09-21 7:23 ` Michael Haggerty
2012-09-21 16:27 ` Junio C Hamano
2012-09-21 19:42 ` Junio C Hamano
2012-09-20 21:26 ` [PATCH v2 00/14] new git check-ignore sub-command Junio C Hamano
2012-09-20 21:43 ` Junio C Hamano
2012-09-20 23:45 ` Adam Spiers
2012-09-21 4:34 ` Junio C Hamano
2012-12-16 19:35 ` [PATCH 0/3] Help newbie git developers avoid obvious pitfalls Adam Spiers
2012-12-16 19:35 ` Adam Spiers [this message]
2012-12-16 23:15 ` [PATCH 1/3] SubmittingPatches: add convention of prefixing commit messages Junio C Hamano
2012-12-16 19:36 ` [PATCH 2/3] Documentation: move support for old compilers to CodingGuidelines Adam Spiers
2012-12-16 19:36 ` [PATCH 3/3] Makefile: use -Wdeclaration-after-statement if supported Adam Spiers
2012-12-17 1:52 ` Junio C Hamano
2012-12-17 2:15 ` Adam Spiers
2012-12-17 4:18 ` Junio C Hamano
2012-12-22 12:25 ` Adam Spiers
2012-12-22 18:39 ` Junio C Hamano
2012-12-26 15:44 ` [PATCH v2 00/14] new git check-ignore sub-command Adam Spiers
2012-09-21 19:00 ` Junio C Hamano
2012-12-16 23:04 ` compiler checks Adam Spiers
2012-09-24 22:31 ` [PATCH v2 00/14] new git check-ignore sub-command Junio C Hamano
2012-09-04 13:06 ` [PATCH 9/9] Add git-check-ignores Nguyen Thai Ngoc Duy
2012-09-04 17:26 ` Junio C Hamano
2012-09-05 10:25 ` Nguyen Thai Ngoc Duy
2012-09-10 11:15 ` Adam Spiers
2012-09-10 11:09 ` Adam Spiers
2012-09-10 12:25 ` Nguyen Thai Ngoc Duy
2012-09-10 16:30 ` Junio C Hamano
2012-09-02 20:35 ` [PATCH 0/9] new git check-ignore sub-command Junio C Hamano
2012-09-06 17:44 ` Adam Spiers
2012-09-07 10:03 ` Adam Spiers
2012-09-07 16:45 ` Junio C Hamano
2012-09-19 19:00 ` [PATCH] Document conventions on static initialization and else cuddling Adam Spiers
2012-09-19 20:43 ` Junio C Hamano
2012-09-19 21:14 ` Adam Spiers
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1355686561-1057-2-git-send-email-git@adamspiers.org \
--to=git@adamspiers.org \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).