aboutsummaryrefslogtreecommitdiffstats
path: root/admin/notes
diff options
context:
space:
mode:
Diffstat (limited to 'admin/notes')
-rw-r--r--admin/notes/bug-triage102
-rw-r--r--admin/notes/copyright2
-rw-r--r--admin/notes/font-backend2
-rw-r--r--admin/notes/hydra2
-rw-r--r--admin/notes/multi-tty2
-rw-r--r--admin/notes/triage68
-rw-r--r--admin/notes/unicode2
-rw-r--r--admin/notes/www2
8 files changed, 108 insertions, 74 deletions
diff --git a/admin/notes/bug-triage b/admin/notes/bug-triage
new file mode 100644
index 00000000000..7392fb96985
--- /dev/null
+++ b/admin/notes/bug-triage
@@ -0,0 +1,102 @@
1HOW TO TRIAGE EMACS BUGS -*- outline -*-
2
3This document just describes the procedure of triaging bugs, for information on
4how to work with the bug tracker, see the bugtracker file in this same directory
5for the basics. You can also install the debbugs ELPA package for access to M-x
6debbugs-gnu, an emacs interface to debbugs, and M-x debbugs-org, an emacs
7interface via org-mode.
8
9* Bug backlog triage procedure
10
11The goal of this triage is to prune down the list of old bugs, closing
12the ones that are not reproducible on the current release.
13
14 1. To start, enter debbugs mode (either debbugs-gnu, debbugs-org, or via the
15 web browser), and accept the default list option of bugs that have severity
16 serious, important, or normal.
17 2. This will also show closed bugs that have yet to be archived. You can
18 filter these out in debbugs-gnu with "x" (debbugs-gnu-toggle-suppress).
19 3. For each bug, we want to primarily make sure it is still
20 reproducible. A bug can and should stay open as long as it is
21 still a bug and no one has fixed it. The following is a
22 suggested checklist to follow for handling these bugs, along with
23 example replies. The various closings, taggings, etc, are done
24 with debbugs control messages, which in debbugs-gnu is initiated
25 with a "C".
26 [ ] Read the mail thread for the bug. Find out if anyone has
27 been able to reproduce this on the current release. If
28 someone has been able to, then your work is finished for this
29 bug.
30 [ ] Make sure there's enough information to reproduce the bug.
31 It should be very clear how to reproduce. If not, please ask
32 for specific steps to reproduce. If you don't get them, and
33 you can't reproduce without them, you can close as
34 "doneunreproducible". Sometimes there is specific hardware
35 involved, such as particular models of keyboards, or it may
36 simply involve a platform you don't have access to. It's
37 fine to ignore those, and let a future triager that is better
38 equipped to reproduce it handle it.
39
40 An example reply asking for clear reproduction steps would be
41 something like: "Hi! In the interest of seeing whether this
42 is reproducible, and to aid anyone who will look at this bug
43 in the future, can you please give instructions on how to
44 reproduce this bug starting from an emacs without
45 configuration ("emacs -Q")?
46 [ ] If there is enough detail to reproduce, but no one has
47 mentioned being able to reproduce on the current release,
48 read the bug description and attempt to reproduce on an emacs
49 started with "emacs -Q" (the goal is to not let our personal
50 configs interfere with bug testing).
51
52 If you can reproduce, then reply on the thread (either on the
53 original message, or anywhere you find appropriate) that you
54 can reproduce this on the current release. If your
55 reproduction gives additional info (such as a backtrace),
56 then add that as well, since it will help whoever attempts to
57 fix it.
58
59 Example reply: "I'd just like to add that I can reproduce
60 this on the latest version of Emacs, Emacs 25."
61
62 If you can't reproduce, state that you can't reproduce it on
63 the current release, ask if they can try again against the
64 current release. Tag the bug as "unreproducable". Wait a
65 few weeks for their reply - if they can reproduce it, then
66 that's great, otherwise close as "doneunreproducible".
67
68 Example reply: "I've attempted to reproduce this on the
69 latest version of emacs, Emacs 25, but haven't been able to.
70 Can you try to reproduce this on this version, and let us
71 know if you are able to? If I don't hear back in a few
72 weeks, I'll just close this bug as unreproducible."
73 [ ] Check that the priority is reasonable. Most bugs should be
74 marked as normal, but crashers and security issues can be
75 marked as "severe".
76 4. Your changes will take some time to take effect. After a period of minutes
77 to hours, you will get a mail telling you the control message has been
78 processed. At this point, if there were no errors detected, you and
79 everyone else can see your changes. If there are errors, read the error
80 text - if you need help, consulting the bugtracker documentation in this
81 same directory.
82
83* New bug triage process
84
85The goal of the new bug triage process is similar to the backlog triage process,
86except that the focus is on prioritizing the bug, and making sure it is has
87necessary information for others to act on.
88
89For each new bug, ask the following questions:
90
91 1. Is the bug report written in a way to be easy to reproduce (starts from
92 emacs -Q, etc.)? If not, ask the reporter to try and reproduce it on an
93 emacs without customization.
94 2. Is the bug report written against the latest emacs? If not, try to
95 reproduce on the latest version, and if it can't be reproduced, ask the
96 reporter to try again with the latest version.
97 3. Is the bug the same as another bug? If so, merge the bugs.
98 4. What is the priority of the bug? Add a priority: critical, grave, serious,
99 important, normal, minor, or wishlist.
100 5. Who should be the owner? This depends on what component the bug is part
101 of. You can look at the admin/MAINTAINERS file (then you can just search
102 emacs-devel to match the name with an email address).
diff --git a/admin/notes/copyright b/admin/notes/copyright
index 3ba9c55d246..2dc33c164a9 100644
--- a/admin/notes/copyright
+++ b/admin/notes/copyright
@@ -1,4 +1,4 @@
1Copyright (C) 2007-2015 Free Software Foundation, Inc. 1Copyright (C) 2007-2016 Free Software Foundation, Inc.
2See the end of the file for license conditions. 2See the end of the file for license conditions.
3 3
4 4
diff --git a/admin/notes/font-backend b/admin/notes/font-backend
index 03663d38cd8..5b65ae5b25a 100644
--- a/admin/notes/font-backend
+++ b/admin/notes/font-backend
@@ -1,4 +1,4 @@
1Copyright (C) 2002-2015 Free Software Foundation, Inc. 1Copyright (C) 2002-2016 Free Software Foundation, Inc.
2See the end of the file for license conditions. 2See the end of the file for license conditions.
3 3
4 4
diff --git a/admin/notes/hydra b/admin/notes/hydra
index ce4a683f6fe..aadc169018b 100644
--- a/admin/notes/hydra
+++ b/admin/notes/hydra
@@ -1,6 +1,6 @@
1-*- mode: outline; coding: utf-8 -*- 1-*- mode: outline; coding: utf-8 -*-
2 2
3Copyright (C) 2013-2015 Free Software Foundation, Inc. 3Copyright (C) 2013-2016 Free Software Foundation, Inc.
4See the end of the file for license conditions. 4See the end of the file for license conditions.
5 5
6NOTES FOR EMACS CONTINUOUS BUILD ON HYDRA 6NOTES FOR EMACS CONTINUOUS BUILD ON HYDRA
diff --git a/admin/notes/multi-tty b/admin/notes/multi-tty
index 868d45138d8..ac1c7b283a1 100644
--- a/admin/notes/multi-tty
+++ b/admin/notes/multi-tty
@@ -1,6 +1,6 @@
1-*- coding: utf-8; mode: text; -*- 1-*- coding: utf-8; mode: text; -*-
2 2
3Copyright (C) 2007-2015 Free Software Foundation, Inc. 3Copyright (C) 2007-2016 Free Software Foundation, Inc.
4See the end of the file for license conditions. 4See the end of the file for license conditions.
5 5
6From README.multi-tty in the multi-tty branch. 6From README.multi-tty in the multi-tty branch.
diff --git a/admin/notes/triage b/admin/notes/triage
deleted file mode 100644
index 5b0e35c144c..00000000000
--- a/admin/notes/triage
+++ /dev/null
@@ -1,68 +0,0 @@
1HOW TO TRIAGE EMACS BUGS -*- outline -*-
2
3This document just describes the procedure of triaging bugs, for information on
4how to work with the bug tracker, see the bugtracker file in this same directory
5for the basics. You can also install the debbugs ELPA package for access to M-x
6debbugs-gnu, an emacs interface to debbugs, and M-x debbugs-org, an emacs
7interface via org-mode.
8
9* Bug backlog triage procedure
10
11The goal of this triage is to prune down the list of old bugs, closing
12the ones that are not reproducible on the current release.
13
14 1. To start, enter debbugs mode (either debbugs-gnu, debbugs-org, or via the
15 web browser), and accept the default list option of bugs that have severity
16 serious, important, or normal.
17 2. This will also show closed bugs that have yet to be archived. You can
18 filter these out in debbugs-gnu with "x" (debbugs-gnu-toggle-suppress).
19 3. For each bug, do the following:
20 - Read the mail thread for the bug. Find out if anyone has been able to
21 reproduce this on the current release.
22 - If someone has been able to, then your work is finished for this bug.
23 - Make sure there's enough information to reproduce the bug. It should be
24 very clear how to reproduce. If not, please ask for specific steps to
25 reproduce. If you don't get them, and you can't reproduce without them,
26 you can close as "doneunreproducible".
27 - If no one has mentioned being able to reproduce on the current release,
28 read the bug description and attempt to reproduce on an emacs started
29 with "emacs -Q" (the goal is to not let our personal configs interfere
30 with bug testing).
31 - If you can reproduce, then reply on the thread (either on the original
32 message, or anywhere you find appropriate) that you can reproduce this on
33 the current release. If your reproduction gives additional info (such as
34 a backtrace), then add that as well, since it will help whoever attempts
35 to fix it.
36 - If you can't reproduce, state that you can't reproduce it on the current
37 release, ask if they can try again against the current release. Tag the
38 bug as "unreproducable". Wait a few weeks for their reply - if they can
39 reproduce it, then that's great, otherwise close as "doneunreproducible".
40 - If the bug ends up still open, make sure the priority and other tags
41 seems reasonable.
42 4. Your changes will take some time to take effect. After a period of minutes
43 to hours, you will get a mail telling you the control message has been
44 processed. At this point, if there were no errors detected, you and
45 everyone else can see your changes. If there are errors, read the error
46 text - if you need help, consulting the bugtracker documentation in this
47 same directory.
48
49* New bug triage process
50
51The goal of the new bug triage process is similar to the backlog triage process,
52except that the focus is on prioritizing the bug, and making sure it is has
53necessary information for others to act on.
54
55For each new bug, ask the following questions:
56
57 1. Is the bug report written in a way to be easy to reproduce (starts from
58 emacs -Q, etc.)? If not, ask the reporter to try and reproduce it on an
59 emacs without customization.
60 2. Is the bug report written against the latest emacs? If not, try to
61 reproduce on the latest version, and if it can't be reproduced, ask the
62 reporter to try again with the latest version.
63 3. Is the bug the same as another bug? If so, merge the bugs.
64 4. What is the priority of the bug? Add a priority: critical, grave, serious,
65 important, normal, minor, or wishlist.
66 5. Who should be the owner? This depends on what component the bug is part
67 of. You can look at the admin/MAINTAINERS file (then you can just search
68 emacs-devel to match the name with an email address).
diff --git a/admin/notes/unicode b/admin/notes/unicode
index 3901f60954f..51314b199f6 100644
--- a/admin/notes/unicode
+++ b/admin/notes/unicode
@@ -1,6 +1,6 @@
1 -*-mode: text; coding: utf-8;-*- 1 -*-mode: text; coding: utf-8;-*-
2 2
3Copyright (C) 2002-2015 Free Software Foundation, Inc. 3Copyright (C) 2002-2016 Free Software Foundation, Inc.
4See the end of the file for license conditions. 4See the end of the file for license conditions.
5 5
6Importing a new Unicode Standard version into Emacs 6Importing a new Unicode Standard version into Emacs
diff --git a/admin/notes/www b/admin/notes/www
index 27aabe0766c..eddaa91ab3c 100644
--- a/admin/notes/www
+++ b/admin/notes/www
@@ -1,6 +1,6 @@
1-*- outline -*- 1-*- outline -*-
2 2
3Copyright (C) 2013-2015 Free Software Foundation, Inc. 3Copyright (C) 2013-2016 Free Software Foundation, Inc.
4See the end of the file for license conditions. 4See the end of the file for license conditions.
5 5
6NOTES FOR EMACS WWW PAGES 6NOTES FOR EMACS WWW PAGES