Skip to content

Commit

Permalink
DOC: Instruct to run git bisect when triaging a regression report (#5…
Browse files Browse the repository at this point in the history
…8813)

* DOC: Instruct to run git bisect when triaging a regression report

* Fix typo

* Suggest to add regression label
  • Loading branch information
Aloqeely authored May 23, 2024
1 parent b5b2d38 commit 3b48b17
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions doc/source/development/maintaining.rst
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Here's a typical workflow for triaging a newly opened issue.
example. See https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports
for a good explanation. If the example is not reproducible, or if it's
*clearly* not minimal, feel free to ask the reporter if they can provide
and example or simplify the provided one. Do acknowledge that writing
an example or simplify the provided one. Do acknowledge that writing
minimal reproducible examples is hard work. If the reporter is struggling,
you can try to write one yourself and we'll edit the original post to include it.

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

If this is a regression report, post the result of a ``git bisect`` run.
More info on this can be found in the :ref:`maintaining.regressions` section.

Ensure the issue exists on the main branch and that it has the "Needs Triage" tag
until all steps have been completed. Add a comment to the issue once you have
verified it exists on the main branch, so others know it has been confirmed.
Expand Down Expand Up @@ -125,7 +128,10 @@ Here's a typical workflow for triaging a newly opened issue.
If the issue is clearly defined and the fix seems relatively straightforward,
label the issue as "Good first issue".

Once you have completed the above, make sure to remove the "needs triage" label.
If the issue is a regression report, add the "Regression" label and the next patch
release milestone.

Once you have completed the above, make sure to remove the "Needs Triage" label.

.. _maintaining.regressions:

Expand Down

0 comments on commit 3b48b17

Please sign in to comment.