Skip to content

Commit a908b3b

Browse files
chore: add issue form for ⚡️ Performance (#5406)
1 parent 15f5980 commit a908b3b

File tree

2 files changed

+51
-0
lines changed

2 files changed

+51
-0
lines changed
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
body:
2+
- type: markdown
3+
attributes:
4+
value: |
5+
Thanks for taking the time to suggest a performance improvement to Mocha! Please note that Mocha is a widely used library with many millions of weekly downloads, many thousands of dependents, and many years of longstanding behavior. Every change to it is inherently risky and may break user edge cases that we have no way to learn of otherwise.
6+
7+
So, to accept a performance improvement, we'd need to see _measurable, non-negligible improvement_ in Mocha's real-world usage. That requires providing at least:
8+
9+
- Exhaustive comparison with other alternatives that proves this is the winning approach
10+
- Disclosure of any personal affiliation with the proposed solution and alternatives
11+
- For runtime performance: some kind of reproducible benchmark to demonstrate exactly what's different
12+
- For dependency cleanups:
13+
- The specific change to the dependency tree of a project with Mocha and no other dependencies
14+
- The specific change to the dependency tree of a project with Mocha and other common dependencies, such as `chai`, `express`, and `sinon`
15+
16+
You can always suggest a performance improvement without those validations, but we are unlikely to accept it without them.
17+
For more information, see [mochajs/mocha#5377 🛠️ Repo: Add issue template for performance improvements](https://github.com/mochajs/mocha/issues/5377).
18+
- attributes:
19+
description: If any of these required steps are not taken, we may not be able to review your issue. Help us to help you!
20+
label: Performance Suggestion Checklist
21+
options:
22+
- label: I am using the latest version of Mocha.
23+
required: true
24+
- label: I have read and understood the nuances around performance reports.
25+
required: true
26+
- label: I have read and agree to Mocha's [Code of Conduct](https://github.com/mochajs/mocha/blob/main/.github/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/mochajs/mocha/blob/main/.github/CONTRIBUTING.md)
27+
required: true
28+
- label: I have searched for [related issues](https://github.com/mochajs/mocha/issues?q=is%3Aissue) and [issues with the `faq` label](https://github.com/mochajs/mocha/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3Afaq%20), but none matched my issue.
29+
required: true
30+
- label: I want to provide a PR to resolve this
31+
type: checkboxes
32+
- attributes:
33+
description: What is your suggestion?
34+
label: Overview
35+
type: textarea
36+
validations:
37+
required: true
38+
- attributes:
39+
description: If you have a suggested implementation, please explain why you believe it's the best one here.
40+
label: Validations
41+
type: textarea
42+
- attributes:
43+
description: Any additional info you'd like to provide.
44+
label: Additional Info
45+
type: textarea
46+
description: Suggest a way to make Mocha faster, more memory- and/or space-efficient, or otherwise improve performance
47+
labels:
48+
- 'area: performance'
49+
- 'status: in triage'
50+
name: ⚡️ Performance
51+
title: '⚡️ Performance: <short description of the change>'
File renamed without changes.

0 commit comments

Comments
 (0)