X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=contributing.mdwn;h=3729a766cbbc9948401b3c149a15d8c6131227aa;hb=df77a5ccd1b0581b1cb3a7ebcf14df7eb048053b;hp=1c8bd5bdd266650a3b3c5fbb403c74101fa969d5;hpb=882d2cdc07b55af79c5354fb2562daee22a62b81;p=obsolete%2Fnotmuch-wiki diff --git a/contributing.mdwn b/contributing.mdwn index 1c8bd5b..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 @@ -214,6 +222,12 @@ subject line with "BUG:" or similar. Tag the message as a bug in Even better, send a patch adding a "known broken" test to the test suite highlighting the issue. +## Update the Notmuch website + +Update the Notmuch website, especially if you've landed a commit that +changes or obsoletes information on the site. It's a wiki; see the +[[instructions on how to edit the wiki|wikiwriteaccess]]. + ## Join the Notmuch IRC channel Patch review happens on the Notmuch mailing list, but there is plenty of