Skip to content

Commit

Permalink
fix ISSUE_TEMPLATE bugs
Browse files Browse the repository at this point in the history
* `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
  • Loading branch information
acao committed Jul 5, 2023
1 parent 2f15e20 commit 4473ce8
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 138 deletions.
34 changes: 12 additions & 22 deletions .github/ISSUE_TEMPLATE/graphiql-bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down
29 changes: 11 additions & 18 deletions .github/ISSUE_TEMPLATE/language-server-bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
67 changes: 0 additions & 67 deletions .github/ISSUE_TEMPLATE/monaco-graphql-bug.yml

This file was deleted.

19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/monaco-graphql-feature.md

This file was deleted.

12 changes: 0 additions & 12 deletions .github/ISSUE_TEMPLATE/vscode-graphql-syntax-bug.yml

This file was deleted.

0 comments on commit 4473ce8

Please sign in to comment.