Skip to content

Commit 3b48b17

Browse files
authored
DOC: Instruct to run git bisect when triaging a regression report (pandas-dev#58813)
* DOC: Instruct to run git bisect when triaging a regression report * Fix typo * Suggest to add regression label
1 parent b5b2d38 commit 3b48b17

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

doc/source/development/maintaining.rst

+8-2
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Here's a typical workflow for triaging a newly opened issue.
8484
example. See https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports
8585
for a good explanation. If the example is not reproducible, or if it's
8686
*clearly* not minimal, feel free to ask the reporter if they can provide
87-
and example or simplify the provided one. Do acknowledge that writing
87+
an example or simplify the provided one. Do acknowledge that writing
8888
minimal reproducible examples is hard work. If the reporter is struggling,
8989
you can try to write one yourself and we'll edit the original post to include it.
9090

@@ -93,6 +93,9 @@ Here's a typical workflow for triaging a newly opened issue.
9393
If a reproducible example is provided, but you see a simplification,
9494
edit the original post with your simpler reproducible example.
9595

96+
If this is a regression report, post the result of a ``git bisect`` run.
97+
More info on this can be found in the :ref:`maintaining.regressions` section.
98+
9699
Ensure the issue exists on the main branch and that it has the "Needs Triage" tag
97100
until all steps have been completed. Add a comment to the issue once you have
98101
verified it exists on the main branch, so others know it has been confirmed.
@@ -125,7 +128,10 @@ Here's a typical workflow for triaging a newly opened issue.
125128
If the issue is clearly defined and the fix seems relatively straightforward,
126129
label the issue as "Good first issue".
127130

128-
Once you have completed the above, make sure to remove the "needs triage" label.
131+
If the issue is a regression report, add the "Regression" label and the next patch
132+
release milestone.
133+
134+
Once you have completed the above, make sure to remove the "Needs Triage" label.
129135

130136
.. _maintaining.regressions:
131137

0 commit comments

Comments
 (0)