Skip to content

Commit 3a4c4b7

Browse files
chore: add 'status: in triage' label to issue templates and docs (#5093)
* docs: mention 10.3.0-prerelease in CHANGELOG.md * Release v10.3.0-preminor.0 * docs: add 10.3.0 to CHANGELOG.md * Release v10.3.0 * chore: add 'status: in triage' label to issue templates and docs
1 parent 6531df8 commit 3a4c4b7

6 files changed

+21
-17
lines changed

.github/CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,10 @@ Then:
7979

8080
### 🎋 Initial Creation
8181

82+
1. Make sure the issue is labeled with [`status: accepting prs`](https://github.com/mochajs/mocha/issues?q=is%3Aissue+is%3Aopen+label%3A%22status%3A+accepting+prs%22)
8283
1. Create a new branch in your working copy.
83-
Give your branch a descriptive name, such as `issue/12345`: `git checkout -b issue/12345`.
8484
1. Make your changes and add them via `git add`.
85-
- Your changes will likely be somewhere in `lib/`, `bin/` or `browser-entry.js` (if your changes are browser-specific).
85+
- Your changes will likely be somewhere in `lib/`, `bin/`, or (if your changes are browser-specific) `browser-entry.js`.
8686
- Unit and/or integration **tests are required** for any code change.
8787
These live in `test/`.
8888
- **Do not modify** the root `mocha.js` file directly; it is automatically generated.

.github/ISSUE_TEMPLATE/01-bug.yml

+3-2
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ body:
4141
type: textarea
4242
description: Report a bug trying to run the code
4343
labels:
44-
- "type: bug"
44+
- 'status: in triage'
45+
- 'type: bug'
4546
name: 🐛 Bug
46-
title: "🐛 Bug: <short description of the bug>"
47+
title: '🐛 Bug: <short description of the bug>'

.github/ISSUE_TEMPLATE/02-documentation.yml

+3-2
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ body:
2121
type: textarea
2222
description: Report a typo or missing area of documentation
2323
labels:
24-
- "area: documentation"
24+
- 'area: documentation'
25+
- 'status: in triage'
2526
name: 📝 Docs
26-
title: "📝 Docs: <short description of the request>"
27+
title: '📝 Docs: <short description of the request>'

.github/ISSUE_TEMPLATE/03-feature-request.yml

+3-2
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ body:
3333
type: textarea
3434
description: Request that a new feature be added or an existing feature improved
3535
labels:
36-
- "type: feature"
36+
- 'status: in triage'
37+
- 'type: feature'
3738
name: 🚀 Feature
38-
title: "🚀 Feature: <short description of the feature>"
39+
title: '🚀 Feature: <short description of the feature>'

.github/ISSUE_TEMPLATE/04-repository-tooling.yml

+3-2
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ body:
2525
type: textarea
2626
description: Report a bug or request an enhancement in the Mocha repository's internal tooling
2727
labels:
28-
- "area: repository tooling"
28+
- 'area: repository tooling'
29+
- 'status: in triage'
2930
name: 🛠 Repository Tooling
30-
title: "🛠 Repo: <short description of the change>"
31+
title: '🛠 Repo: <short description of the change>'

MAINTAINERS.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -211,8 +211,8 @@ For all issues, apply the following labels based on which area(s) the issue pert
211211
- `area: async`: Issues around Mocha's asynchronous usage
212212
- `area: browser`: Issues unique to a browser environment
213213
- `area: parallel`: Issues around Mocha's parallel mode
214-
- `area: qa`: Issues around Mocha's own test suite
215214
- `area: reporter`: Usually concerning Mocha's output
215+
- `area: repository tooling`: Issues around Mocha's CI, own test suite, or other internal tooling
216216
- `area: security`: Involving vulnerabilities, actual or potential
217217
- `area: windows`: Windows-specific issues, particularly around path discrepancies
218218

@@ -221,13 +221,14 @@ Additionally:
221221
- `good first issue`: If the implementation is likely doable by someone who's never contributed to Mocha (or potentially any other open source project) before
222222
- `status: duplicate`: If an equivalent issue was already filed, add this label, close as not planned, and comment with something like `duplicate of #<other-issue-number>`
223223
- `status: in discussion`: Add this whenever the issue is blocked on community input and/or deeper discussions
224+
- `status: in triage`: Added on new issues; re-add this whenever the issue is awaiting maintainer attention
224225
- `status: waiting for author`: Add this whenever the issue is blocked on something from the author
225226

226227
### 🐛 Bugs
227228

228229
Bug reports should include a way to reproduce the issue that someone who is not deeply familiar with Mocha can work with locally.
229230

230-
Depending on that reproduction, add the following label(s) in addition to the auto-added `type: bug`:
231+
Depending on that reproduction, remove `status: in triage` and add the following label(s) in addition to the auto-added `type: bug`:
231232

232233
- If the bug is valid and reproduction works: add `status: accepting prs`
233234
- If the bug might be valid but the reproduction isn't workable:
@@ -244,14 +245,14 @@ Depending on that reproduction, add the following label(s) in addition to the au
244245

245246
Documentation reports should clearly indicate a gap or problem that should be addressed in documentation.
246247
Triage documentation issues similar to bugs and/or feature requests - documentation is its own form of product area.
247-
Keep the auto-added `area: documentation` label.
248+
Remove `status: in triage` and keep the auto-added `area: documentation` label.
248249

249250
### 🚀 Features
250251

251252
Feature requests should include a compelling reason why we should spend the maintenance time on the feature.
252253
Given that Mocha is prioritizing stability over growth, this can be a high bar.
253254

254-
Depending on the reasoning, add the following label(s) in addition to the auto-added `type: feature`:
255+
Depending on the reasoning, remove `status: in triage` and add the following label(s) in addition to the auto-added `type: feature`:
255256

256257
- If the reasoning is valid and seems worth the maintenance cost: add `status: accepting prs`
257258
- If the reasoning is unclear:
@@ -268,12 +269,12 @@ Depending on the reasoning, add the following label(s) in addition to the auto-a
268269

269270
Issues filed about improvements to Mocha's internal development processes.
270271
These can be more informally discussed by maintainers.
271-
Keep the auto-added `area: repository tooling`.
272+
Remove `status: in triage` and keep the auto-added `area: repository tooling`.
272273

273274
### ❓ Questions
274275

275276
Our issue tracker is not the right place to ask questions.
276-
If an issue is filed that seems like it's more of a question, add the `type: question` label, politely direct the user to the [❓ Got a Question?](./.github/CONTRIBUTING.md#❓-got-a-question) section, and close the issue as not planned.
277+
If an issue is filed that seems like it's more of a question, remove `status: in triage`, add the `type: question` label, politely direct the user to the [❓ Got a Question?](./.github/CONTRIBUTING.md#❓-got-a-question) section, and close the issue as not planned.
277278

278279
If it's _not_ a Mocha problem (people tend not to believe this), you may want to show a counter-example.
279280
It's often helpful to direct the issue author to the responsible project, if you can determine what that is.
@@ -405,7 +406,6 @@ _It's easier to release often._
405406
1. Back in your working copy, run `npm publish`.
406407
_If you're doing a prerelease, ensure that you use `--tag=next`._
407408
1. Announce the update on Twitter or just tell your dog or something.
408-
New releases will be automatically tweeted by [@b0neskull](https://twitter.com/b0neskull) via a feed subscription to Mocha's "releases" page on GitHub.
409409

410410
_Note: there are too many steps above._
411411

0 commit comments

Comments
 (0)