From deb6c5b7cd1d221348628423b8759d9fe0b7c414 Mon Sep 17 00:00:00 2001 From: Uri Goldshtein Date: Sun, 26 Jun 2022 16:30:34 +0300 Subject: [PATCH 1/3] New issue template --- .github/ISSUE_TEMPLATE/bug_report.md | 59 ------------------ .github/ISSUE_TEMPLATE/bug_report.yml | 87 +++++++++++++++++++++++++++ 2 files changed, 87 insertions(+), 59 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 0f0e730213f..00000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -name: Bug report -about: Create a bug report to help us improve ---- - -### Issue workflow progress - -_Progress of the issue based on the [Contributor Workflow](https://github.com/the-guild-org/Stack/blob/master/CONTRIBUTING.md#a-typical-contributor-workflow)_ - -- [ ] 1. The issue provides a reproduction available on [GitHub](https://github.com/dotansimha/graphql-code-generator-issue-sandbox-template), [Stackblitz](https://stackblitz.com/github/dotansimha/graphql-code-generator-issue-sandbox-template) or [CodeSandbox](https://codesandbox.io/s/github/dotansimha/graphql-code-generator-issue-sandbox-template) - -> Make sure to fork this template and run `yarn generate` in the terminal. -> -> Please make sure the Codegen and plugins version under `package.json` matches yours. - -- [ ] 2. A failing test has been provided -- [ ] 3. A local solution has been provided -- [ ] 4. A pull request is pending review - ---- - -**Describe the bug** - - - -**To Reproduce** -Steps to reproduce the behavior: - -1. My GraphQL schema: - -```graphql -# Put your schema here -``` - -2. My GraphQL operations: - -```graphql -# Put your operations here -``` - -3. My `codegen.yml` config file: - -```yaml -# Put your YML here -``` - -**Expected behavior** - - - -**Environment:** - -- OS: -- `@graphql-codegen/...`: -- NodeJS: - -**Additional context** - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000000..f940db4375b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,87 @@ +name: '🐛 Bug report' +description: Create a report to help us improve +body: + - type: markdown + attributes: + value: | + Thank you for reporting an issue :pray:. + + The issues on this repo are being tracked and monitored according to our [Contributor Workflow](https://github.com/the-guild-org/Stack/blob/master/CONTRIBUTING.md#a-typical-contributor-workflow), Before submitting a new bug/issue, please check the [Contributor Workflow](https://github.com/the-guild-org/Stack/blob/master/CONTRIBUTING.md#a-typical-contributor-workflow) + + After reading the [Contributor Workflow](https://github.com/the-guild-org/Stack/blob/master/CONTRIBUTING.md#a-typical-contributor-workflow), Check out and update the current state of this issue: + + - [ ] 1. The issue provides a [minimal reproduction](https://stackoverflow.com/help/mcve) available on [GitHub](https://github.com/dotansimha/graphql-code-generator-issue-sandbox-template), [Stackblitz](https://stackblitz.com/github/dotansimha/graphql-code-generator-issue-sandbox-template) or [CodeSandbox](https://codesandbox.io/s/github/dotansimha/graphql-code-generator-issue-sandbox-template). + - _Make sure to fork this template and run `yarn generate` in the terminal._ + - _Please make sure the Codegen and plugins version under `package.json` matches yours._ + - [ ] 2. A failing test has been provided + - [ ] 3. A local solution has been provided + - [ ] 4. A pull request is pending review + + The more information you fill in, the better the community can help you. + - type: textarea + id: description + attributes: + label: Describe the bug + description: Provide a clear and concise description of the challenge you are running into. + validations: + required: true + - type: input + id: link + attributes: + label: Your Example Website or App + description: | + Which website or app were you using when the bug happened? + Note: + - Your bug will may get fixed much faster if we can run your code and it doesn't have dependencies other than the `@graphql-codegen/*` npm related packages / dependencies. + - To create a shareable code example you can use [GitHub](https://github.com/dotansimha/graphql-code-generator-issue-sandbox-template), [Stackblitz](https://stackblitz.com/github/dotansimha/graphql-code-generator-issue-sandbox-template) or [CodeSandbox](https://codesandbox.io/s/github/dotansimha/graphql-code-generator-issue-sandbox-template). Please no localhost URLs. + - Please read these tips for providing a minimal example: https://stackoverflow.com/help/mcve. + placeholder: | + e.g. https://codesandbox.io/...... OR Github Repo + validations: + required: true + - type: textarea + id: steps + attributes: + label: Steps to Reproduce the Bug or Issue + description: Describe the steps we have to take to reproduce the behavior. + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected behavior + description: Provide a clear and concise description of what you expected to happen. + placeholder: | + As a user, I expected ___ behavior but i am seeing ___ + validations: + required: true + - type: textarea + id: screenshots_or_videos + attributes: + label: Screenshots or Videos + description: | + If applicable, add screenshots or a video to help explain your problem. + For more information on the supported file image/file types and the file size limits, please refer + to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files + placeholder: | + You can drag your video or image files inside of this editor ↓ + - type: textarea + id: platform + attributes: + label: Platform + value: | + - OS: [e.g. macOS, Windows, Linux] + - NodeJS: [e.g. 18.5.0] + - `@graphql-codegen/*` version(s): [e.g. 2.6.2] + validations: + required: true + - type: textarea + id: additional + attributes: + label: Additional context + description: Add any other context about the problem here. From 352b849e84ab664cb0678fde7242410970624f92 Mon Sep 17 00:00:00 2001 From: Uri Goldshtein Date: Sun, 26 Jun 2022 16:45:10 +0300 Subject: [PATCH 2/3] Fixes from review --- .github/ISSUE_TEMPLATE/bug_report.yml | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index f940db4375b..92131636a7a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -10,7 +10,7 @@ body: After reading the [Contributor Workflow](https://github.com/the-guild-org/Stack/blob/master/CONTRIBUTING.md#a-typical-contributor-workflow), Check out and update the current state of this issue: - - [ ] 1. The issue provides a [minimal reproduction](https://stackoverflow.com/help/mcve) available on [GitHub](https://github.com/dotansimha/graphql-code-generator-issue-sandbox-template), [Stackblitz](https://stackblitz.com/github/dotansimha/graphql-code-generator-issue-sandbox-template) or [CodeSandbox](https://codesandbox.io/s/github/dotansimha/graphql-code-generator-issue-sandbox-template). + - [ ] 1. The issue provides a [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) available on [GitHub](https://github.com/dotansimha/graphql-code-generator-issue-sandbox-template), [Stackblitz](https://stackblitz.com/github/dotansimha/graphql-code-generator-issue-sandbox-template) or [CodeSandbox](https://codesandbox.io/s/github/dotansimha/graphql-code-generator-issue-sandbox-template). - _Make sure to fork this template and run `yarn generate` in the terminal._ - _Please make sure the Codegen and plugins version under `package.json` matches yours._ - [ ] 2. A failing test has been provided @@ -34,7 +34,7 @@ body: Note: - Your bug will may get fixed much faster if we can run your code and it doesn't have dependencies other than the `@graphql-codegen/*` npm related packages / dependencies. - To create a shareable code example you can use [GitHub](https://github.com/dotansimha/graphql-code-generator-issue-sandbox-template), [Stackblitz](https://stackblitz.com/github/dotansimha/graphql-code-generator-issue-sandbox-template) or [CodeSandbox](https://codesandbox.io/s/github/dotansimha/graphql-code-generator-issue-sandbox-template). Please no localhost URLs. - - Please read these tips for providing a minimal example: https://stackoverflow.com/help/mcve. + - Please read these tips for providing a minimal example: https://stackoverflow.com/help/minimal-reproducible-example. placeholder: | e.g. https://codesandbox.io/...... OR Github Repo validations: @@ -77,9 +77,25 @@ body: value: | - OS: [e.g. macOS, Windows, Linux] - NodeJS: [e.g. 18.5.0] + - `graphql` version: [e.g. 16.3.0] - `@graphql-codegen/*` version(s): [e.g. 2.6.2] validations: required: true + - type: textarea + id: config + attributes: + label: Codegen Config File + description: Your local Codegen config file (YAML/JSON...) + placeholder: | + schema: schema.graphql + documents: document.graphql + generates: + types.ts: + plugins: + - typescript + - typescript-operations + validations: + required: true - type: textarea id: additional attributes: From c6320743b09ebc43b7c64deab8ab53ab211660ec Mon Sep 17 00:00:00 2001 From: Uri Goldshtein Date: Mon, 27 Jun 2022 13:51:10 +0300 Subject: [PATCH 3/3] Make Codegen Config optional --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 92131636a7a..0b6fc80d027 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -94,8 +94,6 @@ body: plugins: - typescript - typescript-operations - validations: - required: true - type: textarea id: additional attributes: