[Emacs-diffs] emacs/admin/notes bugtracker

[Glenn Morris]

CVSROOT:        /sources/emacs
Module name:    emacs
Changes by:     Glenn Morris <gm>       09/03/14 20:29:40

Modified files:
        admin/notes    : bugtracker 

Log message:
        Mention some ChangeLog issues.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/emacs/admin/notes/bugtracker?cvsroot=emacs&r1=1.34&r2=1.35

Patches:
Index: bugtracker
===================================================================
RCS file: /sources/emacs/emacs/admin/notes/bugtracker,v
retrieving revision 1.34
retrieving revision 1.35
diff -u -b -r1.34 -r1.35
--- bugtracker  26 Feb 2009 03:52:06 -0000      1.34
+++ bugtracker  14 Mar 2009 20:29:40 -0000      1.35
@@ -278,6 +278,26 @@
 discards valid mails. Adding a subject (pointless in control messages)
 may help.
 
+** ChangeLog issues
+
+*** When you fix a bug, it can be helpful to put the bug number in the
+ChangeLog entry, for example:
+
+   * foo.el (foofunc): Fix the `foo' case.  (Bug#123)
+
+Then the relevant bug can be found for easy reference.  If it's an
+obvious fix (e.g. a typo), there's no need to clutter the log with the
+bug number.
+
+Similarly, when you close a bug, it can be helpful to include the
+relevant ChangeLog entry in the message to the bug tracker, so people
+can see eaxctly what the fix was.
+
+*** bug-reference-mode
+
+Activate `bug-reference-mode' in ChangeLogs to get clickable links to
+the bug web-pages.
+
 ** Gnus-specific voodoo
 
 *** Put point on a bug-number and try: M-x gnus-read-ephemeral-emacs-bug-group