X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=contributing.mdwn;h=7c5323a24c3997c0cc44834c40ecfb6f68317aea;hb=6af7f7dbf56bba07b8e3dcd567f51230c230b8d4;hp=1c8bd5bdd266650a3b3c5fbb403c74101fa969d5;hpb=882d2cdc07b55af79c5354fb2562daee22a62b81;p=notmuch-wiki diff --git a/contributing.mdwn b/contributing.mdwn index 1c8bd5b..7c5323a 100644 --- a/contributing.mdwn +++ b/contributing.mdwn @@ -9,7 +9,8 @@ but once you get the hang of it, it'll be fun. This page should help you get there. DON'T PANIC. The headlines below act as a checklist. Not all of them apply in all -situations; use common sense. +situations. Use your best judgment, and the Notmuch community will +help out as needed. [[!toc levels=2]] @@ -105,7 +106,7 @@ in the Notmuch source for further information. ## Update the documentation If you modify or add new features to the Notmuch command-line tools, -you should update the manual pages under the `man` directory of the +you should update the manual pages under the `doc` directory of the Notmuch source. If you modify or add new features to the Notmuch Emacs UI, you should @@ -116,6 +117,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 @@ -125,7 +134,7 @@ before submitting patches. ## Send your patches to the mailing list Changes to Notmuch are contributed as [emailed -patches](http://git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project#Public-Large-Project). +patches](http://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#Public-Project-over-Email). Once you have your changes ready in your local repository, you need to send them to the Notmuch mailing list. The simplest way is to use `git send-email` to send the patches directly from your repository: @@ -160,7 +169,7 @@ like email. This applies to patch and bug tracking as well. The Notmuch project uses [nmbug](http://notmuchmail.org/nmbug/) for tracking. The Notmuch developers will tag your patches too, making them show up in the -[nmbug status page](http://nmbug.tethera.net/status/), but requesting +[nmbug status page](http://nmbug.notmuchmail.org/status/), but requesting access and tagging your patches yourself will be helpful in the long run. @@ -182,14 +191,13 @@ have changed; be sure to rebase your updated changes on top of the current master. Once you have the updated series ready, send it to the mailing list -again. It will be helpful for others to use the -`--subject-prefix="PATCH vN"` option of `git format-patch` or -`git send-email` to add a version number of the patch series to the -subject (replacing vN with v2, v3, etc.) Use a cover letter (or, in -the case of a single patch, the notes after a "---" at the end of the -commit message) to summarize the main changes since the previous -version of the patch series. Also include the message-id reference of -the previous version. +again. It will be helpful for others to use the `-vN` option of `git +format-patch` or `git send-email` to add a version number of the patch +series to the subject (replacing vN with v2, v3, etc.) Use a cover +letter (or, in the case of a single patch, the notes after a "---" at +the end of the commit message) to summarize the main changes since the +previous version of the patch series. Also include the message-id +reference of the previous version. Using the `--in-reply-to` option of `git format-patch` or `git send-email` to send the patch series as a reply to the earlier @@ -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