The Notmuch source code is maintained in [git](http://git-scm.com/). Get the
source code using:
- git clone git://notmuchmail.org/git/notmuch
+ git clone https://git.notmuchmail.org/git/notmuch
This guide assumes a working knowledge of git. There are plenty of resources
available on git, such as [Pro Git](http://git-scm.com/book) and the git man
If you modify or add new features to the Notmuch Emacs UI, you should
update the Emacs documentation.
+If you add a new keybinding, update `devel/emacs-keybindings.org`. As
+much as possible, try to be consistent between modes.
+
## Update NEWS
If you make user visible changes, you should add an entry to the
[`NEWS`](https://git.notmuchmail.org/git/notmuch/blob/HEAD:/NEWS) file.
+In practice adding NEWS items can be done later during the release
+process, but then you typically get a one line mention, if at all.
+
## Update command-line completion
If you modify or add new features to the Notmuch command-line tools, it
## Subscribe to the Notmuch mailing list
While strictly not required, it is advisable to subscribe to the
-[Notmuch mailing list](https://notmuchmail.org/mailman/listinfo/notmuch)
+[Notmuch mailing list](https://nmbug.notmuchmail.org/list/)
before submitting patches.
## Send your patches to the mailing list
extra information you want to share that is not really part of the
commit messages, it is advisable to write a cover letter to give an
overview of your work. See the
-[Notmuch mailing list archives](https://notmuchmail.org/pipermail/notmuch/)
+[Notmuch mailing list archives](https://nmbug.notmuchmail.org/nmweb/)
for examples. Use the `--cover-letter` option of `git format-patch`,
or `--compose` option of `git send-email`.
Notmuch project uses [nmbug](https://notmuchmail.org/nmbug/) for
tracking. The Notmuch developers will tag your patches too, making
them show up in the
-[nmbug status page](http://nmbug.notmuchmail.org/status/), but requesting
+[nmbug status page](https://nmbug.notmuchmail.org/status/), but requesting
access and tagging your patches yourself will be helpful in the long
run.
changes. You are expected to follow up on the review comments you
receive, either by discussing the comments and the code, or modifying
your patches. Again, see the [Notmuch mailing list
-archives](https://notmuchmail.org/pipermail/notmuch/) for examples.
+archives](https://nmbug.notmuchmail.org/nmweb) for examples.
## Send another round addressing review comments
## Join the Notmuch IRC channel
Patch review happens on the Notmuch mailing list, but there is plenty of
-discussion going on in the freenode #notmuch IRC channel. See
-[freenode.net/irc_servers.shtml](http://freenode.net/irc_servers.shtml)
+discussion going on in the libera #notmuch IRC channel. See
+[libera.chat/guides/connect](https://libera.chat/guides/connect)
for information how to get there.