Skip to content

Commit 45dda50

Browse files
JohnVillalovosnejch
authored andcommitted
docs: update CONTRIBUTING.rst with policy on issue management
Also update the `stale` job to close issues with no activity, unless they are assigned to someone.
1 parent 2bab8d4 commit 45dda50

File tree

2 files changed

+82
-7
lines changed

2 files changed

+82
-7
lines changed

.github/workflows/stale.yml

Lines changed: 46 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,56 @@ jobs:
2020
stale-issue-label: "stale"
2121
stale-pr-label: "stale"
2222

23-
any-of-labels: 'need info,Waiting for response,stale'
23+
# If an issue/PR has an assignee it won't be marked as stale
24+
exempt-all-assignees: true
2425
stale-issue-message: >
25-
This issue was marked stale because it has been open 60 days with no
26-
activity. Please remove the stale label or comment on this issue. Otherwise,
27-
it will be closed in 15 days.
26+
This issue was marked stale because it has been open 60 days with
27+
no activity. Please remove the stale label or comment on this
28+
issue. Otherwise, it will be closed in 15 days.
29+
30+
As an open-source project, we rely on community contributions to
31+
address many of the reported issues. Without a proposed fix or
32+
active work towards a solution it is our policy to close inactive
33+
issues. This is documented in CONTRIBUTING.rst
34+
35+
**How to keep this issue open:**
36+
* If you are still experiencing this issue and are willing to
37+
investigate a fix, please comment and let us know.
38+
* If you (or someone else) can propose a pull request with a
39+
solution, that would be fantastic.
40+
* Any significant update or active discussion indicating progress
41+
will also prevent closure.
42+
43+
We value your input. If you can help provide a fix, we'd be happy
44+
to keep this issue open and support your efforts.
45+
2846
days-before-issue-stale: 60
2947
days-before-issue-close: 15
3048
close-issue-message: >
31-
This issue was closed because it has been marked stale for 15 days with no
32-
activity. If this issue is still valid, please re-open.
49+
This issue was closed because it has been marked stale for 15 days
50+
with no activity.
51+
52+
This open-source project relies on community contributions, and
53+
while we value all feedback, we have a limited capacity to address
54+
every issue without a clear path forward.
55+
56+
Currently, this issue hasn't received a proposed fix, and there
57+
hasn't been recent active discussion indicating someone is planning
58+
to work on it. To maintain a manageable backlog and focus our
59+
efforts, we will be closing this issue for now.
60+
61+
**This doesn't mean the issue isn't valid or important.** If you or
62+
anyone else in the community is willing to investigate and propose
63+
a solution (e.g., by submitting a pull request), please do.
64+
65+
We believe that those who feel a bug is important enough to fix
66+
should ideally be part of the solution. Your contributions are
67+
highly welcome.
68+
69+
Thank you for your understanding and potential future
70+
contributions.
71+
72+
This is documented in CONTRIBUTING.rst
3373
3474
stale-pr-message: >
3575
This Pull Request (PR) was marked stale because it has been open 90 days
@@ -40,4 +80,3 @@ jobs:
4080
close-pr-message: >
4181
This PR was closed because it has been marked stale for 15 days with no
4282
activity. If this PR is still valid, please re-open.
43-

CONTRIBUTING.rst

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,42 @@ You can contribute to the project in multiple ways:
99
* Add unit and functional tests
1010
* Everything else you can think of
1111

12+
Issue Management and Our Approach to Contributions
13+
--------------------------------------------------
14+
15+
We value every contribution and bug report. However, as an open-source project
16+
with limited maintainer resources, we rely heavily on the community to help us
17+
move forward.
18+
19+
**Our Policy on Inactive Issues:**
20+
21+
To keep our issue tracker manageable and focused on actionable items, we have
22+
the following approach:
23+
24+
* **We encourage reporters to propose solutions:** If you report an issue, we
25+
strongly encourage you to also think about how it might be fixed and try to
26+
implement that fix.
27+
* **Community interest is key:** Issues that garner interest from the community
28+
(e.g., multiple users confirming, discussions on solutions, offers to help)
29+
are more likely to be addressed.
30+
* **Closing inactive issues:** If an issue report doesn't receive a proposed
31+
fix from the original reporter or anyone else in the community, and there's
32+
no active discussion or indication that someone is willing to work on it
33+
after a reasonable period, it may be closed.
34+
35+
* When closing such an issue, we will typically leave a comment explaining
36+
that it's being closed due to inactivity and a lack of a proposed fix.
37+
38+
* **Reopening issues:** This doesn't mean the issue isn't valid. If you (or
39+
someone else) are interested in working on a fix for a closed issue, please
40+
comment on the issue. We are more than happy to reopen it and discuss your
41+
proposed pull request or solution. We greatly appreciate it when community
42+
members take ownership of fixing issues they care about.
43+
44+
We believe this approach helps us focus our efforts effectively and empowers
45+
the community to contribute directly to the areas they are most passionate
46+
about.
47+
1248
Development workflow
1349
--------------------
1450

0 commit comments

Comments
 (0)