X-Git-Url: https://git.cworth.org/git?p=obsolete%2Fnotmuch-wiki;a=blobdiff_plain;f=contributing.mdwn;h=3729a766cbbc9948401b3c149a15d8c6131227aa;hp=d7faa039aea7917b3539c043ab335100e82b01f0;hb=HEAD;hpb=d38c66d73f4da53ebe05379e5078c7573bd50e75 diff --git a/contributing.mdwn b/contributing.mdwn index d7faa03..3729a76 100644 --- a/contributing.mdwn +++ b/contributing.mdwn @@ -58,7 +58,7 @@ Each commit should contain one logical change only. The code should build and the tests should pass after each commit. Changes to lib, cli, emacs, tests, man pages, or news are usually best kept separate. Also separate cleanups from functional changes. See the -Notmuch source history (`git log`) for examples. +Notmuch source history (**`git log`**) for examples. For in-depth discussion on the subject, see [Software Release Practice HOWTO](http://tldp.org/HOWTO/Software-Release-Practice-HOWTO/) by Eric S. Raymond. @@ -74,8 +74,8 @@ See also on commit guidelines, including commit messages. It is customary to prefix the subject line with "lib:", "cli:", "emacs:", -etc. depending on which part of Notmuch the commit is changing. See `git log` -for examples. +etc. depending on which part of Notmuch the commit is changing. See +**`git log`** for examples. Wrap the lines to about 72 characters. @@ -116,6 +116,14 @@ update the Emacs documentation. If you make user visible changes, you should add an entry to the [`NEWS`](http://git.notmuchmail.org/git/notmuch/blob/HEAD:/NEWS) file. +## Update command-line completion + +If you modify or add new features to the Notmuch command-line tools, it +would be a nice bonus if you also updated the Notmuch command-line +completion scripts under the `completion` directory of the Notmuch +source. Not required, but nice to have, and definitely can be done +afterwards. + ## Subscribe to the Notmuch mailing list While strictly not required, it is advisable to subscribe to the