| 1 |
From 3939c7bc514acf487f56a4893dbcbb28abbb1ade Mon Sep 17 00:00:00 2001 |
| 2 |
From: Robert <rspier@pobox.com> |
| 3 |
Date: Mon, 10 May 2010 20:36:54 -0700 |
| 4 |
Subject: Add guidelines for commit messages |
| 5 |
|
| 6 |
From git-commit(1) |
| 7 |
--- |
| 8 |
docs/development.pod | 11 ++++++++++- |
| 9 |
1 files changed, 10 insertions(+), 1 deletions(-) |
| 10 |
|
| 11 |
diff --git a/docs/development.pod b/docs/development.pod |
| 12 |
index f991942..0f345e1 100644 |
| 13 |
--- a/docs/development.pod |
| 14 |
+++ b/docs/development.pod |
| 15 |
@@ -52,10 +52,19 @@ When you're ready to check it in... |
| 16 |
git add lib/Qpsmtpd.pm # to let git know you changed the file |
| 17 |
git add --patch plugin/tls # interactive choose which changes to add |
| 18 |
git diff --cached # review changes added |
| 19 |
- git commit |
| 20 |
+ git commit # describe the commit |
| 21 |
git log -p # review your commit a last time |
| 22 |
git push origin # to send to github |
| 23 |
|
| 24 |
+=head3 Commit Descriptions |
| 25 |
+ |
| 26 |
+Though not required, it's a good idea to begin the commit message with |
| 27 |
+a single short (less than 50 character) line summarizing the change, |
| 28 |
+followed by a blank line and then a more thorough description. Tools |
| 29 |
+that turn commits into email, for example, use the first line on the |
| 30 |
+Subject: line and the rest of the commit in the body. |
| 31 |
+(From: L<git-commit(1)>) |
| 32 |
+ |
| 33 |
=head3 Submit patches by mail |
| 34 |
|
| 35 |
The best way to submit patches to the project is to send them to the |
| 36 |
-- |
| 37 |
1.7.2.2 |
| 38 |
|
Parent Directory
| 
Revision Log
| 
Revision Graph
