From 548fbd0a3688cf9eba2b5149c798d596271dc316 Mon Sep 17 00:00:00 2001 From: Artem Zakharchenko Date: Fri, 11 Mar 2022 15:35:12 +0100 Subject: [PATCH] chore: add issue template forms (#1162) --- .github/ISSUE_TEMPLATE/01-issue-browser.yml | 66 +++++++++++++++++++ .../01-not_intercepted_in_browser.md | 51 -------------- .github/ISSUE_TEMPLATE/02-issue-nodejs.yml | 65 ++++++++++++++++++ .../02-not_intercepted_in_node.md | 52 --------------- .github/ISSUE_TEMPLATE/03-bug_report.md | 32 --------- .github/ISSUE_TEMPLATE/03-feature.yml | 33 ++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ------ 7 files changed, 164 insertions(+), 155 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/01-issue-browser.yml delete mode 100644 .github/ISSUE_TEMPLATE/01-not_intercepted_in_browser.md create mode 100644 .github/ISSUE_TEMPLATE/02-issue-nodejs.yml delete mode 100644 .github/ISSUE_TEMPLATE/02-not_intercepted_in_node.md delete mode 100644 .github/ISSUE_TEMPLATE/03-bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/03-feature.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/01-issue-browser.yml b/.github/ISSUE_TEMPLATE/01-issue-browser.yml new file mode 100644 index 000000000..de33ff2e7 --- /dev/null +++ b/.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 diff --git a/.github/ISSUE_TEMPLATE/01-not_intercepted_in_browser.md b/.github/ISSUE_TEMPLATE/01-not_intercepted_in_browser.md deleted file mode 100644 index 56f4765c2..000000000 --- a/.github/ISSUE_TEMPLATE/01-not_intercepted_in_browser.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -name: 'Issue: Browser interception' -about: My request is not intercepted/mocked in a browser -title: '' -labels: bug, scope:browser -assignees: '' ---- - -## Environment - -| Name | Version | -| ------- | ------- | -| msw | 0.0.0 | -| browser | XXX | -| OS | XXX | - -## Request handlers - - - -```js -// Example of declaration. Provide your code here. -import { setupWorker, rest } from 'msw' - -const worker = setupWorker( - rest.get('???', () => {...}) -) - -worker.start() -``` - -## Actual request - - - -```js -// Example of making a request. Provide your code here. -fetch('???').then((res) => res.json()) -``` - -## Current behavior - - - -## Expected behavior - - - -## Screenshots - - diff --git a/.github/ISSUE_TEMPLATE/02-issue-nodejs.yml b/.github/ISSUE_TEMPLATE/02-issue-nodejs.yml new file mode 100644 index 000000000..f3f2d1d29 --- /dev/null +++ b/.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 diff --git a/.github/ISSUE_TEMPLATE/02-not_intercepted_in_node.md b/.github/ISSUE_TEMPLATE/02-not_intercepted_in_node.md deleted file mode 100644 index b9f53c022..000000000 --- a/.github/ISSUE_TEMPLATE/02-not_intercepted_in_node.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -name: 'Issue: Node.js interception' -about: My request is not intercepted/mocked in Node.js (tests) -title: '' -labels: bug, scope:node -assignees: '' ---- - -## Environment - -| Name | Version | -| ---- | ------- | -| msw | 0.0.0 | -| node | XXX | -| OS | XXX | - -## Request handlers - - - -```js -// Example of declaration. Provide your code here. -import { setupServer } from 'msw/node' -import { rest } from 'msw' - -const server = setupServer( - rest.get('???', () => {...}) -) - -server.listen() -``` - -## Actual request - - - -```js -// Example of making a request. Provide your code here. -fetch('???').then((res) => res.json()) -``` - -## Current behavior - - - -## Expected behavior - - - -## Screenshots - - diff --git a/.github/ISSUE_TEMPLATE/03-bug_report.md b/.github/ISSUE_TEMPLATE/03-bug_report.md deleted file mode 100644 index fad1e6cd4..000000000 --- a/.github/ISSUE_TEMPLATE/03-bug_report.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: Bug report -about: Report an issue to improve Mock Service Worker -title: '' -labels: bug -assignees: '' - ---- - -## Describe the bug -A clear and concise description of what the bug is. - -## Environment - -- `msw: 0.0.0` -- `nodejs: 0.0.0` -- `npm: 0.0.0` - -> Please also provide your browser version. - -## To Reproduce -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -## Expected behavior -A clear and concise description of what you expected to happen. - -## Screenshots -If applicable, add screenshots to help explain your problem. diff --git a/.github/ISSUE_TEMPLATE/03-feature.yml b/.github/ISSUE_TEMPLATE/03-feature.yml new file mode 100644 index 000000000..7b6f4ff42 --- /dev/null +++ b/.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 diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index adc89423d..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest a feature or improvement -title: '' -labels: feature -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here.