You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: .github/CONTRIBUTING.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -79,10 +79,10 @@ Then:
79
79
80
80
### 🎋 Initial Creation
81
81
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)
82
83
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`.
84
84
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`.
86
86
- Unit and/or integration **tests are required** for any code change.
87
87
These live in `test/`.
88
88
-**Do not modify** the root `mocha.js` file directly; it is automatically generated.
Copy file name to clipboardexpand all lines: MAINTAINERS.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -211,8 +211,8 @@ For all issues, apply the following labels based on which area(s) the issue pert
211
211
-`area: async`: Issues around Mocha's asynchronous usage
212
212
-`area: browser`: Issues unique to a browser environment
213
213
-`area: parallel`: Issues around Mocha's parallel mode
214
-
-`area: qa`: Issues around Mocha's own test suite
215
214
-`area: reporter`: Usually concerning Mocha's output
215
+
-`area: repository tooling`: Issues around Mocha's CI, own test suite, or other internal tooling
216
216
-`area: security`: Involving vulnerabilities, actual or potential
217
217
-`area: windows`: Windows-specific issues, particularly around path discrepancies
218
218
@@ -221,13 +221,14 @@ Additionally:
221
221
-`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
222
222
-`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>`
223
223
-`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
224
225
-`status: waiting for author`: Add this whenever the issue is blocked on something from the author
225
226
226
227
### 🐛 Bugs
227
228
228
229
Bug reports should include a way to reproduce the issue that someone who is not deeply familiar with Mocha can work with locally.
229
230
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`:
231
232
232
233
- If the bug is valid and reproduction works: add `status: accepting prs`
233
234
- 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
244
245
245
246
Documentation reports should clearly indicate a gap or problem that should be addressed in documentation.
246
247
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.
248
249
249
250
### 🚀 Features
250
251
251
252
Feature requests should include a compelling reason why we should spend the maintenance time on the feature.
252
253
Given that Mocha is prioritizing stability over growth, this can be a high bar.
253
254
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`:
255
256
256
257
- If the reasoning is valid and seems worth the maintenance cost: add `status: accepting prs`
257
258
- If the reasoning is unclear:
@@ -268,12 +269,12 @@ Depending on the reasoning, add the following label(s) in addition to the auto-a
268
269
269
270
Issues filed about improvements to Mocha's internal development processes.
270
271
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`.
272
273
273
274
### ❓ Questions
274
275
275
276
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.
277
278
278
279
If it's _not_ a Mocha problem (people tend not to believe this), you may want to show a counter-example.
279
280
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._
405
406
1. Back in your working copy, run `npm publish`.
406
407
_If you're doing a prerelease, ensure that you use `--tag=next`._
407
408
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.
0 commit comments