diff options
| author | Stefan Kangas | 2023-09-04 17:28:53 +0200 |
|---|---|---|
| committer | Stefan Kangas | 2023-09-04 17:29:00 +0200 |
| commit | ff5190a174f993b5b2f262cebdb259d7c6211b2e (patch) | |
| tree | 4985aa1d5cd2e99afb6089ca3621ed59f083b0b6 /admin | |
| parent | f1e4cbe72aa4da9351cbbcd209d9233c68dd9fbb (diff) | |
| download | emacs-ff5190a174f993b5b2f262cebdb259d7c6211b2e.tar.gz emacs-ff5190a174f993b5b2f262cebdb259d7c6211b2e.zip | |
Add note on ELPA to admin/notes/bug-triage
* admin/notes/bug-triage: Add section on (Non-)GNU ELPA packages and
do some copy editing.
Diffstat (limited to 'admin')
| -rw-r--r-- | admin/notes/bug-triage | 71 |
1 files changed, 51 insertions, 20 deletions
diff --git a/admin/notes/bug-triage b/admin/notes/bug-triage index bee7242337d..6fad55dc1e3 100644 --- a/admin/notes/bug-triage +++ b/admin/notes/bug-triage | |||
| @@ -1,10 +1,10 @@ | |||
| 1 | HOW TO TRIAGE EMACS BUGS -*- outline -*- | 1 | HOW TO TRIAGE EMACS BUGS -*- outline -*- |
| 2 | 2 | ||
| 3 | This document just describes the procedure of triaging bugs, for information on | 3 | This document describes the procedure of triaging bugs. For information on how |
| 4 | how to work with the bug tracker, see the bugtracker file in this same directory | 4 | to work with the bug tracker, see the file "bugtracker" in the same directory as |
| 5 | for the basics. You can also install the debbugs ELPA package for access to M-x | 5 | this file for the basics. You can also install the GNU ELPA package 'debbugs' |
| 6 | debbugs-gnu, an emacs interface to debbugs, and M-x debbugs-org, an emacs | 6 | for access to 'M-x debbugs-gnu', an Emacs interface to the debbugs bug tracker, |
| 7 | interface via org-mode. | 7 | and 'M-x debbugs-org', an Emacs interface via org-mode. |
| 8 | 8 | ||
| 9 | * Bug backlog triage procedure | 9 | * Bug backlog triage procedure |
| 10 | 10 | ||
| @@ -15,9 +15,10 @@ the ones that are not reproducible on the current release. | |||
| 15 | calling debbugs-gnu-emacs-release-blocking-reports. If you want | 15 | calling debbugs-gnu-emacs-release-blocking-reports. If you want |
| 16 | to check this for another Emacs version but the next-to-be-released-one, | 16 | to check this for another Emacs version but the next-to-be-released-one, |
| 17 | use the "C-u" prefix. | 17 | use the "C-u" prefix. |
| 18 | 1. After that, enter debbugs mode (either debbugs-gnu, debbugs-org, or via the | 18 | 1. After that, enter debbugs mode (either using 'M-x debbugs-gnu', |
| 19 | web browser), and accept the default list option of bugs that have severity | 19 | 'M-x debbugs-org', or via the web browser), and accept the |
| 20 | serious, important, or normal. | 20 | default list option of bugs that have severity "serious", |
| 21 | "important", or "normal". | ||
| 21 | 2. For each bug, we want to primarily make sure it is still | 22 | 2. For each bug, we want to primarily make sure it is still |
| 22 | reproducible. A bug can and should stay open as long as it is | 23 | reproducible. A bug can and should stay open as long as it is |
| 23 | still a bug and no one has fixed it. The following is a | 24 | still a bug and no one has fixed it. The following is a |
| @@ -90,21 +91,51 @@ necessary information for others to act on. | |||
| 90 | 91 | ||
| 91 | For each new bug, ask the following questions: | 92 | For each new bug, ask the following questions: |
| 92 | 93 | ||
| 93 | 1. Is the bug report written in a way to be easy to reproduce (starts from | 94 | 1. Is the bug report written in a way to be easy to reproduce |
| 94 | "emacs -Q", etc.)? If not, ask the reporter to try and reproduce it on an | 95 | (starts from "emacs -Q", etc.)? If not, ask the reporter to try |
| 95 | emacs without customization. | 96 | and reproduce it on an emacs without customization. |
| 96 | 2. Is the bug report written against the latest emacs? If not, try to | 97 | 2. Is the bug report written against the latest emacs? If not, try |
| 97 | reproduce on the latest version, and if it can't be reproduced, ask the | 98 | to reproduce on the latest version, and if it can't be |
| 98 | reporter to try again with the latest version. | 99 | reproduced, ask the reporter to try again with the latest |
| 100 | version. | ||
| 99 | 3. Is the bug the same as another bug? If so, merge the bugs. | 101 | 3. Is the bug the same as another bug? If so, merge the bugs. |
| 100 | 4. What is the priority of the bug? Add a priority: serious, important, | 102 | 4. What is the priority of the bug? Add a priority: "serious", |
| 101 | normal, minor, or wishlist. | 103 | "important", "normal", "minor, or "wishlist". |
| 102 | 5. Who should be the owner? This depends on what component the bug is part | 104 | 5. Who should be the owner? This depends on what component the bug |
| 103 | of. You can look at the admin/MAINTAINERS file (then you can just search | 105 | is part of. You can look at the "Maintainer" comment header in |
| 104 | emacs-devel to match the name with an email address). | 106 | the relevant Lisp files. If you can't find the name there, look |
| 107 | at admin/MAINTAINERS file (then you can just search emacs-devel | ||
| 108 | to match the name with an email address). | ||
| 105 | 109 | ||
| 106 | In the debbugs-gnu buffer, bugs are marked in the "State" column | 110 | In the debbugs-gnu buffer, bugs are marked in the "State" column |
| 107 | according to the communication flow. Red bugs mean that nobody has | 111 | according to the communication flow. Red bugs mean that nobody has |
| 108 | answered, these bugs need primary attention. Green bugs flag that | 112 | answered; these bugs need primary attention. Green bugs flag that |
| 109 | there is a recent communication about, and orange bugs flag that the | 113 | there is a recent communication about, and orange bugs flag that the |
| 110 | bug hasn't been touched for at least two weeks. | 114 | bug hasn't been touched for at least two weeks. |
| 115 | |||
| 116 | * Bugs in GNU ELPA and NonGNU ELPA packages | ||
| 117 | |||
| 118 | The goal here is to ping the relevant maintainers, as Emacs core | ||
| 119 | developers aren't always up-to-date with recent developments in all | ||
| 120 | GNU ELPA packages, and can't do anything with reports about bugs in | ||
| 121 | NonGNU ELPA packages. | ||
| 122 | |||
| 123 | This is how we deal with them: | ||
| 124 | |||
| 125 | 1. Bugs in GNU ELPA packages can always be reported to our bug | ||
| 126 | tracker, even if they are usually tracked by other means. Search | ||
| 127 | for the maintainer of that package, e.g. on | ||
| 128 | https://elpa.gnu.org/packages and take note of their email | ||
| 129 | address. Send a reply with an email body like "<name> is the | ||
| 130 | maintainer of <package>, so I'm copying them in here.", and | ||
| 131 | include their email address in Cc. | ||
| 132 | 2. Bugs in NonGNU ELPA packages should be sent to their maintainers, | ||
| 133 | because we can't do anything to fix them. If you suspect that | ||
| 134 | the bug is about a NonGNU ELPA package, it's usually polite to | ||
| 135 | ask the reporter if this is indeed the case (in case you | ||
| 136 | misunderstood something), and then to point them in the right | ||
| 137 | direction. Such bugs can be closed once the confusion has been | ||
| 138 | resolved. | ||
| 139 | 3. Bugs in third-party packages that are not in any of the above | ||
| 140 | repositories are handled in the same way as packages in NonGNU | ||
| 141 | ELPA. | ||