From 7319a2188793923645e949da0131a60b77b2d9a3 Mon Sep 17 00:00:00 2001 From: Rikki Schulte Date: Wed, 5 Jul 2023 06:35:34 +0200 Subject: [PATCH 1/2] fix ISSUE_TEMPLATE bugs * `render: markdown` leads to a terrible experience for `textarea`, both for editing & reading the text * almost everyone prefers using `*` for md lists over `-` * eliminate sections that are confusing and rarely used (including the templates for `monaco-graphql`) * convert the syntax bug reporting template to markdown, as there is little context that needs to be provided besides a screenshot --- .github/ISSUE_TEMPLATE/graphiql-bug.yml | 34 ++++------ .../ISSUE_TEMPLATE/language-server-bug.yml | 29 +++----- .github/ISSUE_TEMPLATE/monaco-graphql-bug.yml | 67 ------------------- .../ISSUE_TEMPLATE/monaco-graphql-feature.md | 19 ------ .../vscode-graphql-syntax-bug.yml | 12 ---- 5 files changed, 23 insertions(+), 138 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/monaco-graphql-bug.yml delete mode 100644 .github/ISSUE_TEMPLATE/monaco-graphql-feature.md delete mode 100644 .github/ISSUE_TEMPLATE/vscode-graphql-syntax-bug.yml diff --git a/.github/ISSUE_TEMPLATE/graphiql-bug.yml b/.github/ISSUE_TEMPLATE/graphiql-bug.yml index a97cbf87e2d..eeb396d03d1 100644 --- a/.github/ISSUE_TEMPLATE/graphiql-bug.yml +++ b/.github/ISSUE_TEMPLATE/graphiql-bug.yml @@ -31,42 +31,32 @@ body: 2. With this config... 3. Do '...' in [repro codesandbox/stackblitz]() 4. See error... - render: Markdown validations: required: false - - type: checkboxes - attributes: - label: Module pattern - options: - - label: graphiql-umd - - label: graphiql-esm - - label: graphiql-commonjs - type: textarea attributes: label: Environment description: | examples: - - **GraphiQL Version**: latest - - **OS**: Ubuntu 20.04 - - **Browser**: Chrome 106 - - **Bundler**: vite x.y - - **`react` Version**: 18 - - **`graphql` Version**: 16 + * **GraphiQL Version**: latest + * **OS**: Ubuntu 20.04 + * **Browser**: Chrome 106 + * **Bundler**: vite x.y + * **`react` Version**: 18 + * **`graphql` Version**: 16 value: | - - GraphiQL Version: - - OS: - - Browser: - - Bundler: - - `react` Version: - - `graphql` Version: - render: Markdown + * GraphiQL Version: + * OS: + * Browser: + * Bundler: + * `react` Version: + * `graphql` Version: validations: required: false - type: textarea attributes: label: Anything else? - render: Markdown description: | Links? References? Anything that will give us more context about the issue you are encountering! diff --git a/.github/ISSUE_TEMPLATE/language-server-bug.yml b/.github/ISSUE_TEMPLATE/language-server-bug.yml index 01ca76b33bc..1e5994eeb1f 100644 --- a/.github/ISSUE_TEMPLATE/language-server-bug.yml +++ b/.github/ISSUE_TEMPLATE/language-server-bug.yml @@ -11,23 +11,21 @@ body: - label: I have searched the existing issues required: true - - type: textarea + - type: markdown attributes: label: Current Behavior description: A concise description of the issue you're experiencing. - render: Markdown validations: required: false - - type: textarea + - type: markdown attributes: label: Expected Behavior description: A concise description of what you expected to happen. - render: Markdown validations: required: false - - type: textarea + - type: markdown attributes: label: Steps To Reproduce description: Steps to reproduce the behavior. @@ -36,33 +34,28 @@ body: 2. With this (redacted) graphql config with [filename]... 3. Do '...' with [lsp client] 4. See errors in output channel, etc... - render: Markdown validations: required: false - - type: textarea + - type: markdown attributes: label: Environment description: | examples: - - **LSP Server Version**: latest - - **OS**: Ubuntu 20.04 - - **LSP Client**: vscode (`vscode-graphql`, etc), intellij-lsp, nvim coc, etc + * **LSP Server Version**: latest + * **OS**: Ubuntu 20.04 + * **LSP Client**: vscode (`vscode-graphql`, etc), intellij-lsp, nvim coc, etc value: | - - LSP Server Version: - - OS: - - LSP Client: - render: Markdown + * LSP Server Version: + * OS: + * LSP Client: validations: required: false - - type: textarea + - type: markdown attributes: label: Anything else? - render: Markdown description: | Links? References? Anything that will give us more context about the issue you are encountering Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/monaco-graphql-bug.yml b/.github/ISSUE_TEMPLATE/monaco-graphql-bug.yml deleted file mode 100644 index cbd40349156..00000000000 --- a/.github/ISSUE_TEMPLATE/monaco-graphql-bug.yml +++ /dev/null @@ -1,67 +0,0 @@ -name: Monaco GraphQL Bug -description: Report a bug for `monaco-graphql` -title: '[monaco-graphql] ' -labels: [monaco-graphql, bug, needs triage] -body: - - type: checkboxes - attributes: - label: Is there an existing issue for this? - description: Please search to see if an issue already exists for the bug you encountered. - options: - - label: I have searched the existing issues - required: true - - type: textarea - attributes: - label: Current Behavior - description: A concise description of what you're experiencing. - validations: - required: false - - type: textarea - attributes: - label: Expected Behavior - description: A concise description of what you expected to happen. - validations: - required: false - - type: textarea - attributes: - label: Steps To Reproduce - description: Steps to reproduce the behavior. - placeholder: | - 1. With this bundler setup... - 2. With this instantiation pattern... - 3. Do '...' in [repro codesandbox/stackblitz]() - 4. See error/regression... - render: Markdown - validations: - required: false - - type: textarea - attributes: - label: Environment - description: | - examples: - - **GraphiQL Version**: latest - - **OS**: Ubuntu 20.04 - - **Browser**: Chrome 106 - - **Bundler**: vite x.y - - **`graphql` Version**: 16 - - **`monaco-editor` Version**: 30.0.0 - value: | - - GraphiQL Version: - - OS: - - Browser: - - Bundler: - - `graphql` Version: - - `monaco-editor` Version: - render: Markdown - validations: - required: false - - type: textarea - attributes: - label: Anything else? - render: Markdown - description: | - Links? References? Anything that will give us more context about the issue you are encountering! - - Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/monaco-graphql-feature.md b/.github/ISSUE_TEMPLATE/monaco-graphql-feature.md deleted file mode 100644 index 7dcf566aabb..00000000000 --- a/.github/ISSUE_TEMPLATE/monaco-graphql-feature.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: Monaco GraphQL Feature Request -about: Request a feature for `monaco-graphql` -title: '[monaco-graphql] <title>' -labels: [monaco-graphql, enhancement] ---- - -<!-- - -## Current Behavior (if applicable) - - -## Desired Behavior - -## PRs welcome! - -If you find a way to solve this problem or add this feature by modifying the code in either the source or the distributed code, we are more than happy to accept enhancement requests as PRs! - ---> diff --git a/.github/ISSUE_TEMPLATE/vscode-graphql-syntax-bug.yml b/.github/ISSUE_TEMPLATE/vscode-graphql-syntax-bug.yml deleted file mode 100644 index 166caaab1f8..00000000000 --- a/.github/ISSUE_TEMPLATE/vscode-graphql-syntax-bug.yml +++ /dev/null @@ -1,12 +0,0 @@ -name: VSCode GraphQL Syntax Bug -description: Report a bug for `vscode-graphql-syntax` -title: '[vscode-graphql-syntax] <title>' -labels: [vscode-graphql-syntax, bug, needs triage] -body: - - type: checkboxes - attributes: - label: Is there an existing issue for this? - description: Please search to see if an issue already exists for the bug you encountered. - options: - - label: I have searched the existing issues - required: true From 37017e4027d58be3f0ed468ba72a9e5c10dec7a1 Mon Sep 17 00:00:00 2001 From: Rikki Schulte <rikki.schulte@gmail.com> Date: Wed, 5 Jul 2023 06:51:50 +0200 Subject: [PATCH 2/2] type markdown -> type textarea --- .github/ISSUE_TEMPLATE/language-server-bug.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/language-server-bug.yml b/.github/ISSUE_TEMPLATE/language-server-bug.yml index 1e5994eeb1f..8b179448158 100644 --- a/.github/ISSUE_TEMPLATE/language-server-bug.yml +++ b/.github/ISSUE_TEMPLATE/language-server-bug.yml @@ -11,21 +11,21 @@ body: - label: I have searched the existing issues required: true - - type: markdown + - type: textarea attributes: label: Current Behavior description: A concise description of the issue you're experiencing. validations: required: false - - type: markdown + - type: textarea attributes: label: Expected Behavior description: A concise description of what you expected to happen. validations: required: false - - type: markdown + - type: textarea attributes: label: Steps To Reproduce description: Steps to reproduce the behavior. @@ -37,7 +37,7 @@ body: validations: required: false - - type: markdown + - type: textarea attributes: label: Environment description: | @@ -52,7 +52,7 @@ body: validations: required: false - - type: markdown + - type: textarea attributes: label: Anything else? description: |