X-Git-Url: https://git.llucax.com/software/mutt-debian.git/blobdiff_plain/14c29200cb58d3c4a0830265f2433849781858d0..939639fcf1dad1b8f3a85d641f41d11c49281f3c:/doc/devel-notes.txt?ds=inline diff --git a/doc/devel-notes.txt b/doc/devel-notes.txt index ec845ca..31db35e 100644 --- a/doc/devel-notes.txt +++ b/doc/devel-notes.txt @@ -141,6 +141,28 @@ is in the root directory. The script does all the automake/autoconf magic that needs to be done with a fresh checkout. +Contributing patches +-------------------- + +As Mercurial is a distributed version control system, it's easy to +commit changes locally without impacting anybody else's work, starting +over again, or turn several commit and backouts into a new single patch +ready for submission. + +These so-called "changesets" (a diff with a reasonable message +describing the change) can be exported using Mercurial through the +"patchbomb" extension shipped with Mercurial (please see the hg +documentation for details) which also is the preferred format for +submission to the mutt-dev mailing list for discussion and review. + +In order to ease later bisecting in case of bugs and code history, +changes should be grouped logically, feature by feature or bugfix by +bugfix. Especially a single patch fixing several problems at once +should be avoided. + +Before submitting patches, please make sure the check_sec.sh script +in the top-level source directory reports no errors/warnings. + A word about warnings --------------------- @@ -216,10 +238,12 @@ expected to be plain text, with some formatting instructions roughly similar to [ntg]roff: - \fI switches to italics - + - \fB switches to boldface - - \fP switches to normal display + - \fT switches to monospace + + - \fP switches to normal display after \fI, \fB or \fT - \(as can be used to represent an asterisk (*). This is intended to help avoiding character sequences such as /* or */ inside