Skip to content

Commit fed3b21

Browse files
committed
chore: add issue template forms (#1162)
1 parent d7ab139 commit fed3b21

File tree

7 files changed

+163
-155
lines changed

7 files changed

+163
-155
lines changed
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: 'Bug report (Browser)'
2+
description: I experience unexpected behavior using the library in a browser.
3+
labels: ['bug', 'scope:browser', 'needs:triage']
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: Thank you for reporting an issue to Mock Service Worker! Please fill in the template below to help our team tackle it in the most efficient way.
8+
9+
- type: checkboxes
10+
attributes:
11+
label: Prerequisites
12+
description: Before we begin, let's make sure your issue hasn't been solved already.
13+
options:
14+
- label: I confirm my issue is not in the [opened issues](https://github.com/mswjs/msw/issues)
15+
required: true
16+
- label: I confirm the [Frequently Asked Questions](https://mswjs.io/docs/faq) didn't contain the answer to my issue
17+
required: true
18+
19+
- type: checkboxes
20+
attributes:
21+
label: Environment check
22+
options:
23+
- label: I'm using the [latest](https://github.com/mswjs/msw/releases/latest) `msw` version
24+
required: true
25+
- label: I'm using Node.js version 14 or higher
26+
required: true
27+
28+
- type: dropdown
29+
attributes:
30+
label: Browsers
31+
description: Select in which browser(s) you're experiencing the issue.
32+
multiple: true
33+
options:
34+
- 'Chromium (Chrome, Brave, etc.)'
35+
- 'Firefox'
36+
- 'Safari'
37+
38+
- type: input
39+
attributes:
40+
label: Reproduction repository
41+
description: A link to the repository where your issue can be reproduced. You can clone one of [our examples](https://github.com/mswjs/examples/tree/master/examples) or [our CodeSandbox template](https://codesandbox.io/s/msw-react-xx1c8) to create a reproduction repository much faster. Issues without a reproduction repository **will be closed**.
42+
placeholder: i.e. https://github.com/you/msw-issue
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
attributes:
48+
label: Reproduction steps
49+
description: Include any steps necessary to reproduce the issue in the repository above.
50+
placeholder: i.e. "npm test"
51+
validations:
52+
required: true
53+
54+
- type: textarea
55+
attributes:
56+
label: Current behavior
57+
description: Share any details on what behavior you're experiencing (error messages, logs, context).
58+
validations:
59+
required: true
60+
61+
- type: textarea
62+
attributes:
63+
label: Expected behavior
64+
description: What do you expect to happen instead?
65+
validations:
66+
required: true

.github/ISSUE_TEMPLATE/01-not_intercepted_in_browser.md

Lines changed: 0 additions & 51 deletions
This file was deleted.
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: 'Bug report (Node.js)'
2+
description: I experience unexpected behavior using the library in Node.js (Jest/React Native/Express/etc.).
3+
labels: ['bug', 'scope:node', 'needs:triage']
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: Thank you for reporting an issue to Mock Service Worker! Please fill in the template below to help our team tackle it in the most efficient way.
8+
9+
- type: checkboxes
10+
attributes:
11+
label: Prerequisites
12+
description: Before we begin, let's make sure your issue hasn't been solved already.
13+
options:
14+
- label: I confirm my issue is not in the [opened issues](https://github.com/mswjs/msw/issues)
15+
required: true
16+
- label: I confirm the [Frequently Asked Questions](https://mswjs.io/docs/faq) didn't contain the answer to my issue
17+
required: true
18+
19+
- type: checkboxes
20+
attributes:
21+
label: Environment check
22+
description: Next, let's make sure you're using the library in the officially supported environments.
23+
options:
24+
- label: I'm using the [latest](https://github.com/mswjs/msw/releases/latest) `msw` version
25+
required: true
26+
- label: I'm using Node.js version 14 or higher
27+
required: true
28+
29+
- type: input
30+
attributes:
31+
label: Node.js version
32+
description: Specify which Node.js version you're using (`node -v`).
33+
placeholder: i.e. v16.14.0
34+
validations:
35+
required: true
36+
37+
- type: input
38+
attributes:
39+
label: Reproduction repository
40+
description: A link to the repository where your issue can be reproduced. You can clone one of [our examples](https://github.com/mswjs/examples/tree/master/examples) or [our CodeSandbox template](https://codesandbox.io/s/msw-react-xx1c8) to create a reproduction repository much faster. Issues without a reproduction repository **will be closed**.
41+
placeholder: i.e. https://github.com/you/msw-issue
42+
validations:
43+
required: true
44+
45+
- type: textarea
46+
attributes:
47+
label: Reproduction steps
48+
description: Include any steps necessary to reproduce the issue in the repository above.
49+
placeholder: i.e. "npm test"
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
attributes:
55+
label: Current behavior
56+
description: Share any details on what behavior you're experiencing (error messages, logs, context).
57+
validations:
58+
required: true
59+
60+
- type: textarea
61+
attributes:
62+
label: Expected behavior
63+
description: What do you expect to happen instead?
64+
validations:
65+
required: true

.github/ISSUE_TEMPLATE/02-not_intercepted_in_node.md

Lines changed: 0 additions & 52 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/03-bug_report.md

Lines changed: 0 additions & 32 deletions
This file was deleted.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: 'Feature request'
2+
description: Propose a feature or improvement.
3+
labels: [feature]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: Thank you for deciding to make Mock Service Worker better! Please fill in the form below so our team could understand your feature better.
8+
9+
- type: dropdown
10+
attributes:
11+
label: Scope
12+
multiple: false
13+
options:
14+
- 'Adds a new behavior'
15+
- 'Improves an existing behavior'
16+
validations:
17+
required: true
18+
19+
- type: checkboxes
20+
attributes:
21+
label: Compatibility
22+
description: Check if your proposal is a breaking change. Leave this field unchecked if not sure.
23+
options:
24+
- label: This is a breaking change
25+
required: false
26+
27+
- type: textarea
28+
attributes:
29+
label: Feature description
30+
description: "Describe the feature you're suggesting. Be as detailed as possible: include behavior description, pseudo-code snippets, comparison to similar features."
31+
validations:
32+
required: true

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)