Skip to content

Commit 4b428d6

Browse files
committed
Update docs to mention issue policy and needs champion
1 parent 4ed0916 commit 4b428d6

2 files changed

Lines changed: 43 additions & 1 deletion

File tree

docs/source/developers/bug_reports.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,37 @@ reached a terminal status, it is closed with one of two outcomes:
206206
* **closed as not planned** - indicates the issue is closed and should
207207
not receive any further updates, but *without* action being taken.
208208

209+
.. _stale-issues:
210+
211+
Stale issues and pull requests
212+
++++++++++++++++++++++++++++++
213+
214+
To keep the issue tracker manageable, issues and pull requests that have had
215+
no activity for an extended period are automatically marked as stale by a
216+
daily GitHub Actions workflow.
217+
218+
The policy varies by type:
219+
220+
* **Pull requests**: After 365 days of inactivity, a ``Status: stale-warning``
221+
label is added. If there is still no activity after 14 more days, the PR is
222+
closed.
223+
* **Usage issues** (labeled ``Type: usage``): Same 365 + 14 day policy as
224+
pull requests.
225+
* **Enhancement issues** (labeled ``Type: enhancement``): Same 365 + 14 day
226+
policy, but issues labeled ``Status: needs champion`` are exempt from
227+
closure. This label indicates that the enhancement is still desired but
228+
needs someone to take ownership of it.
229+
230+
To prevent an issue or PR from being closed, remove the
231+
``Status: stale-warning`` label or leave a comment explaining that it is
232+
still active.
233+
234+
.. seealso::
235+
236+
If you are looking for issues to work on, issues labeled
237+
``Status: needs champion`` are confirmed-wanted enhancements that need
238+
a contributor. See :ref:`finding-issues` for more.
239+
209240
.. _issue-assignment:
210241

211242
Issue assignment

docs/source/developers/guide/step_by_step/finding_issues.rst

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,18 @@ GitHub issues.
5959
<https://github.com/apache/arrow/labels/good-first-issue>`_
6060

6161
The issues labeled as good first issues should take no more than two days or
62-
a weekend to fix them. Once you dig into the code you may find that the issue
62+
a weekend to fix them.
63+
64+
Another way to find issues is to look for the **"Status: needs champion"**
65+
label. These are enhancement requests that the community has confirmed are
66+
still wanted, but that have no current owner. They may be more complex than
67+
good first issues, but they are a great way to make a meaningful contribution.
68+
69+
.. seealso::
70+
Search for needs champion issues `needs champion label listing
71+
<https://github.com/apache/arrow/labels/Status%3A%20needs%20champion>`_
72+
73+
Once you dig into the code you may find that the issue
6374
is not easy at all - this can happen as the problem could be harder than the
6475
person who triaged the ticket expected it to be. Don't hesitate to write that
6576
in the comments.

0 commit comments

Comments
 (0)