From 15d0fd3a5ba4e9358f5d89363c78fe77daaa01e3 Mon Sep 17 00:00:00 2001 From: Glenn Morris Date: Sat, 14 Mar 2009 20:29:40 +0000 Subject: [PATCH] Mention some ChangeLog issues. --- admin/notes/bugtracker | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/admin/notes/bugtracker b/admin/notes/bugtracker index cc14f3c38dc..030e8f668b6 100644 --- a/admin/notes/bugtracker +++ b/admin/notes/bugtracker @@ -278,6 +278,26 @@ Apparently it has some kind of spam filter that sometimes silently 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 -- 2.39.5