Skip to content

Commit 968ab19

Browse files
authored
chore: improve triage process (#576)
1 parent 6c77528 commit 968ab19

File tree

6 files changed

+57
-5
lines changed

6 files changed

+57
-5
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: Bug Report
22
description: File a bug report
3-
labels: [bug]
3+
labels: ['bug', 'triage']
44
body:
55
- type: dropdown
66
id: read_troubleshooting

.github/ISSUE_TEMPLATE/propose_new_rule.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: Propose a new rule
22
description: Propose a new rule for the eslint-plugin-testing-library.
3-
labels: [new rule]
3+
labels: ['new rule', 'triage']
44
body:
55
- type: input
66
id: name_for_new_rule

.github/ISSUE_TEMPLATE/request_general_change.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: Request a general change
22
description: Request a general change for the eslint-plugin-testing-library.
3-
labels: [enhancement]
3+
labels: ['enhancement', 'triage']
44
body:
55
- type: input
66
id: plugin_version

.github/ISSUE_TEMPLATE/request_rule_change.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: Request a rule change
22
description: Request a rule change for the eslint-plugin-testing-library.
3-
labels: [enhancement]
3+
labels: ['enhancement', 'triage']
44
body:
55
- type: input
66
id: what_rule_do_you_want_to_change

.github/stale.yml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,17 @@
22
daysUntilStale: 60
33
# Number of days of inactivity before a stale issue is closed
44
daysUntilClose: 7
5+
# Only issues or pull requests with all of these labels are checked if stale
6+
onlyLabels:
7+
- 'awaiting response'
8+
- 'new rule'
9+
- enhancement
10+
- invalid
511
# Issues with these labels will never be considered stale
612
exemptLabels:
713
- pinned
814
- security
9-
- bug
15+
- triage
1016
# Label to use when marking an issue as stale
1117
staleLabel: wontfix
1218
# Comment to post when marking an issue as stale. Set to `false` to disable

MAINTAINERS.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
This document outlines some processes that the maintainers should stick to.
2+
3+
## Issues Process
4+
5+
There are 3 types of issues that can be created:
6+
7+
- `"bug"`
8+
- `"new rule"`
9+
- `"enhancement"`
10+
11+
### Triage
12+
13+
The triage process is basically making sure that the issue is correctly reported (and ask for more info if not), and categorize it correctly if it belongs to a different type than initially assigned.
14+
15+
- When a new issue is created, they'll include a `"triage"` label
16+
- If the issue is correctly reported, please remove the `"triage"` label, so we know is valid and ready to be tackled
17+
- If the issue is **not** correctly reported, please ask for more details and add the `"awaiting response"` label, so we know more info has been requested to the author
18+
- If the issue belong to an incorrect category, please update the labels to put it in the right category
19+
- If the issue is duplicated, please close it including a comment with a link to the duplicating issue
20+
21+
## Pull Requests Process
22+
23+
### Main PR workflow
24+
25+
_TODO: pending to describe the main PR process_
26+
27+
### Contributors
28+
29+
When the PR gets merged, please check if the author of the PR or the closed issue (if any) should be added or updated in the [Contributors section](https://github.com/testing-library/eslint-plugin-testing-library#contributors-).
30+
31+
If so, you can ask the [`@all-contributors` bot to add a contributor](https://allcontributors.org/docs/en/bot/usage) in a comment of the merged PR (this works for both adding and updating). Remember to check the [Contribution Types table](https://allcontributors.org/docs/en/emoji-key) to decide which sort of contribution should be assigned.
32+
33+
## Stale bot
34+
35+
This repo uses [probot-stale](https://github.com/probot/stale) to close abandoned issues and PRs after a period of inactivity.
36+
37+
They'll be considered inactive if they match all the following conditions:
38+
39+
- they have been 60 days inactive
40+
- they have at least one of the following labels:
41+
- `"awaiting response"`: we are waiting for more details but the author didn't react
42+
- `"new rule"`: there is a proposal for a new rule that no one could handle
43+
- `"enhancement"`: there is a proposal for an enhancement that no one could handle
44+
- `"invalid"`: something is wrong with the issue/PR and the author didn't take care of it
45+
46+
When flagged as a stale issue or PR, they'll be definitely closed after 7 more days of inactivity. Issues and PRs with the following labels are excluded: `"pinned"`, `"security"`, and "`triage"`. Use the first one if you need to exclude an issue or PR from being closed for whatever reason even if the inactive criteria is matched.

0 commit comments

Comments
 (0)