Skip to content

Commit

Permalink
chore: add issue template forms (#1162)
Browse files Browse the repository at this point in the history
  • Loading branch information
kettanaito committed Mar 11, 2022
1 parent d7ab139 commit 548fbd0
Show file tree
Hide file tree
Showing 7 changed files with 164 additions and 155 deletions.
66 changes: 66 additions & 0 deletions .github/ISSUE_TEMPLATE/01-issue-browser.yml
@@ -0,0 +1,66 @@
name: 'Bug report (Browser)'
description: I experience unexpected behavior using the library in a browser.
labels: ['bug', 'scope:browser', 'needs:triage']
body:
- type: markdown
attributes:
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.

- type: checkboxes
attributes:
label: Prerequisites
description: Before we begin, let's make sure your issue hasn't been solved already.
options:
- label: I confirm my issue is not in the [opened issues](https://github.com/mswjs/msw/issues)
required: true
- label: I confirm the [Frequently Asked Questions](https://mswjs.io/docs/faq) didn't contain the answer to my issue
required: true

- type: checkboxes
attributes:
label: Environment check
options:
- label: I'm using the [latest](https://github.com/mswjs/msw/releases/latest) `msw` version
required: true
- label: I'm using Node.js version 14 or higher
required: true

- type: dropdown
attributes:
label: Browsers
description: Select in which browser(s) you're experiencing the issue.
multiple: true
options:
- 'Chromium (Chrome, Brave, etc.)'
- 'Firefox'
- 'Safari'

- type: input
attributes:
label: Reproduction repository
description: A URL to a GitHub repository where your issue can be reproduced. Issues without a reproduction repository **will be closed**.
placeholder: i.e. https://github.com/you/msw-issue
validations:
required: true

- type: textarea
attributes:
label: Reproduction steps
description: Include any steps necessary to reproduce the issue in the repository above.
placeholder: i.e. "npm test"
validations:
required: true

- type: textarea
attributes:
label: Current behavior
description: Share any details on what behavior you're experiencing (error messages, logs, context).
validations:
required: true

- type: textarea
attributes:
label: Expected behavior
description: What do you expect to happen instead?
validations:
required: true
51 changes: 0 additions & 51 deletions .github/ISSUE_TEMPLATE/01-not_intercepted_in_browser.md

This file was deleted.

65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/02-issue-nodejs.yml
@@ -0,0 +1,65 @@
name: 'Bug report (Node.js)'
description: I experience unexpected behavior using the library in Node.js (Jest/React Native/Express/etc.).
labels: ['bug', 'scope:node', 'needs:triage']
body:
- type: markdown
attributes:
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.

- type: checkboxes
attributes:
label: Prerequisites
description: Before we begin, let's make sure your issue hasn't been solved already.
options:
- label: I confirm my issue is not in the [opened issues](https://github.com/mswjs/msw/issues)
required: true
- label: I confirm the [Frequently Asked Questions](https://mswjs.io/docs/faq) didn't contain the answer to my issue
required: true

- type: checkboxes
attributes:
label: Environment check
description: Next, let's make sure you're using the library in the officially supported environments.
options:
- label: I'm using the [latest](https://github.com/mswjs/msw/releases/latest) `msw` version
required: true
- label: I'm using Node.js version 14 or higher
required: true

- type: input
attributes:
label: Node.js version
description: Specify which Node.js version you're using (`node -v`).
placeholder: i.e. v16.14.0
validations:
required: true

- type: input
attributes:
label: Reproduction repository
description: A URL to a GitHub repository where we can reproduce your issue. Issues without a reproduction repository **will be closed**.
placeholder: i.e. https://github.com/you/msw-issue
validations:
required: true

- type: textarea
attributes:
label: Reproduction steps
description: Include any steps necessary to reproduce the issue in the repository above.
placeholder: i.e. "npm test"
validations:
required: true

- type: textarea
attributes:
label: Current behavior
description: Share any details on what behavior you're experiencing (error messages, logs, context).
validations:
required: true

- type: textarea
attributes:
label: Expected behavior
description: What do you expect to happen instead?
validations:
required: true
52 changes: 0 additions & 52 deletions .github/ISSUE_TEMPLATE/02-not_intercepted_in_node.md

This file was deleted.

32 changes: 0 additions & 32 deletions .github/ISSUE_TEMPLATE/03-bug_report.md

This file was deleted.

33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/03-feature.yml
@@ -0,0 +1,33 @@
name: 'Feature request'
description: Propose a feature or improvement.
labels: [feature]
body:
- type: markdown
attributes:
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.

- type: dropdown
attributes:
label: Scope
description:
multiple: false
options:
- 'Adds a new behavior'
- 'Improves an existing behavior'
validations:
required: true

- type: checkboxes
attributes:
label: Compatibility
description: Check if your proposal is a breaking change. Leave this field unchecked if not sure.
options:
- label: This is a breaking change
required: false

- type: textarea
attributes:
label: Feature description
description: "Describe the feature you're suggesting. Be as detailed as possible: include behavior description, pseudo-code snippets, comparison to similar features."
validations:
required: true
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

0 comments on commit 548fbd0

Please sign in to comment.