X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=patchformatting.mdwn;h=8f3203159ba0800f40b68b20f9b01e758c065ad5;hb=de5f864c4496db53b1b3e13d6e41271311b0a56a;hp=914371d4da071d916340c945304a26f02e06021c;hpb=b2e4da9e0c71a62f053aa9a8586089d77b24f4e9;p=notmuch-wiki diff --git a/patchformatting.mdwn b/patchformatting.mdwn index 914371d..8f32031 100644 --- a/patchformatting.mdwn +++ b/patchformatting.mdwn @@ -33,6 +33,31 @@ Enter your commit message in following format: The 65-character (limit) seems to be common among many projects so that is good guideline to follow here too. +Regarding the commit message body contents, Carl [has stated](http://article.gmane.org/gmane.mail.notmuch.general/504): + +> The single line summary is good about saying *what* the commit does, +> but I always want to see at least one sentence about the *why* as well. + +### Activating default pre-commit hook + +Git provides a default pre-commit hook which, when activated, checks +(at least) for whitespace errors (trailing whitespace and space before +tab). It is better to notice this kind of "errors" early than have +patch reviewers to mention about those. + +The hook, when activated, is named as .git/hooks/pre-commit and it +has execute permissions set on. By default, when git tree is cloned +your hooks dir may have default, inactive pre-commit hook available +as: + +1. .git/hooks/pre-commit without execute permission set + +2. .git/hooks/pre-commit.sample usually with execute permission set + +In case of 2, enter `cp .git/hooks/pre-commit.sample .git/hooks/pre-commit`. +And, now enter `chmod a+x .git/hooks/pre-commit` in case it does not +have execute permission set. + ## Remember: one patch per email Every patch should (must!) contain only one bugfix or new feature.