Skip to content

Commit ba9ccef

Browse files
committed
[DOC] Various fixes in bug triaging guide
1 parent aa01441 commit ba9ccef

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

doc/bug_triaging.rdoc

+12-13
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ If you cannot reproduce the example with the master branch, but can reproduce
2727
the issue on the latest version for the branch, then it is likely the bug has
2828
already been fixed, but it has not been backported yet. Try to determine
2929
which commit fixed it, and update the issue noting that the issue has been
30-
fixed but not yet backported. If the ruby version is in the security
30+
fixed but not yet backported. If the Ruby version is in the security
3131
maintenance phase or no longer supported, change the status to Closed. This
32-
change be made without adding a note to avoid spamming the mailing list.
32+
change can be made without adding a note to avoid spamming the mailing list.
3333

3434
For issues that may require backwards incompatible changes or may benefit from
35-
general committer attention or discussion, considering adding them as agenda
35+
general committer attention or discussion, consider adding them as agenda
3636
items for the next committer meeting (https://bugs.ruby-lang.org/issues/14770).
3737

3838
== Crash Bugs Without Reproducers
@@ -41,27 +41,26 @@ Many bugs reported have little more than a crash report, often with no way to
4141
reproduce the issue. These bugs are difficult to triage as they often do not
4242
contain enough information.
4343

44-
45-
For these bugs, if the ruby version is the master branch or is the latest
44+
For these bugs, if the Ruby version is the master branch or is the latest
4645
release for the branch and the branch is in normal maintenance phase, look at
4746
the backtrace and see if you can determine what could be causing the issue.
48-
If you can guess would could be causing the issue, see if you can put together
47+
If you can guess what could be causing the issue, see if you can put together
4948
a reproducible example (this is in general quite difficult). If you cannot
5049
guess what could be causing the issue, or cannot put together a reproducible
5150
example yourself, please ask the reporter to provide a reproducible example,
5251
and change the status to Feedback.
5352

54-
if the ruby version is no longer current (e.g. 2.5.0 when the latest version
55-
on the ruby 2.5 branch is 2.5.5), add a note to the issue asking the reporter
56-
to try the latest ruby version for the branch and report back, and change the
57-
status to Feedback. If the ruby version is in the security maintenance phase
53+
If the Ruby version is no longer current (e.g. 2.5.0 when the latest version
54+
on the Ruby 2.5 branch is 2.5.5), add a note to the issue asking the reporter
55+
to try the latest Ruby version for the branch and report back, and change the
56+
status to Feedback. If the Ruby version is in the security maintenance phase
5857
or no longer supported, change the status to Closed. This change can be made
5958
without adding a note.
6059

6160
== Crash Bugs With 3rd Party C Extensions
6261

63-
If the crash happens inside a 3rd party C extension, try to figure out which
64-
C extension it happens inside, and add a note to the issue to report the
62+
If the crash happens inside a 3rd party C extension, try to figure out inside
63+
which C extension it happens, and add a note to the issue to report the
6564
issue to that C extension, and set the status to Third Party's Issue.
6665

6766
== Non-Bug reports
@@ -75,6 +74,6 @@ improvements) or Misc. This change can be made without adding a note.
7574
There are many issues that are stale, with no updates in months or even years.
7675
For stale issues in Feedback state, where the feedback has not been received,
7776
you can change the status to Closed without adding a note. For stale issues
78-
in Assigned state, you can reach out the assignee and see if they can update
77+
in Assigned state, you can reach out to the assignee and see if they can update
7978
the issue. If the assignee is no longer an active committer, remove them
8079
as the assignee and change the status to Open.

0 commit comments

Comments
 (0)