X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/0287c2e441fbc748cb11f96a5afd6dbdf68b0818..495fe9e122c1e90d5ce8cddeb5925b0dae22018c:/docs/README.developers diff --git a/docs/README.developers b/docs/README.developers index 3876ba68..f99d1080 100644 --- a/docs/README.developers +++ b/docs/README.developers @@ -6,7 +6,20 @@ This file is intended to provide a few tips for anyone doing development on nmh. Developers who learn things "the hard way" about the nmh codebase (as opposed to local info best encoded in a comment) are encouraged to share their wisdom here. -The topics are organized alphabetically. +Following a commit checklist, the topics are organized alphabetically. + +---------------- +commit checklist +---------------- + +1. code updated? +2. test added? +3. make distcheck passed? +4. man page and other documentation updated? +5. docs/pending-release-notes updated? +6. should commit message reference bug report? +7. update/close bug report (with commit id)? +8. notify nmh-users? ------------------------- @@ -18,7 +31,7 @@ or other related files, you'll need to first install GNU m4, available from , then GNU autoconf () and GNU automake (). Nmh is currently using a -minimum of autoconf 2.61 and automake 1.10. +minimum of autoconf 2.68 and automake 1.12. Most of the configure-related files are automatically generated. The only files you should need to manually edit are configure.ac @@ -136,9 +149,9 @@ getpass() nmh_getpass() releasing nmh ------------- -To make a public release of nmh (we'll use version 1.5 and my mhost.com -account, danh, as examples here; the convention for release candidates -is to use something like "1.5-RC1"): +To make a public release of nmh (we'll use version 1.5 as the example +here; the convention for release candidates is to use something like +"1.5-RC1"): 1. % echo 1.5 > VERSION % date +"%e %B %Y" > DATE @@ -161,7 +174,7 @@ is to use something like "1.5-RC1"): 5. If all is well and your tarball is final, go back to your workspace and do: - % echo 1.0.4+dev > VERSION + % echo 1.5+dev > VERSION 6. % git commit VERSION; git push @@ -185,7 +198,6 @@ is to use something like "1.5-RC1"): exmh-users@redhat.com exmh-workers@redhat.com mh-e-users@lists.sourceforge.net - mh-users@ics.uci.edu *or* comp.mail.mh (there is a bidirectional gateway) If the release fixes significant security holes, also send an announcement to bugtraq@securityfocus.com. The exmh lists require you to be subscribed