Skip to content

Commit 9ef25c8

Browse files
authored
fix: add issue templates (#191)
Add templates to get better issues descriptions from the community
1 parent 31ed670 commit 9ef25c8

File tree

2 files changed

+121
-0
lines changed

2 files changed

+121
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
name: '🐛 Bug report'
2+
description: Create a report to help us improve
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
Thank you for reporting an issue :pray:.
8+
9+
---
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Describe the bug
15+
description: Provide a clear and concise description of the challenge you are running into.
16+
validations:
17+
required: true
18+
- type: input
19+
id: link
20+
attributes:
21+
label: Your Example Website or App
22+
description: |
23+
Which website or app were you using when the bug happened?
24+
Note:
25+
- 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.
26+
- 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.
27+
- Please read these tips for providing a minimal example: https://stackoverflow.com/help/minimal-reproducible-example.
28+
placeholder: |
29+
e.g. https://codesandbox.io/...... OR Github Repo
30+
- type: textarea
31+
id: steps
32+
attributes:
33+
label: Steps to Reproduce the Bug or Issue
34+
description: Describe the steps we have to take to reproduce the behavior.
35+
placeholder: |
36+
1. Go to '...'
37+
2. Click on '....'
38+
3. Scroll down to '....'
39+
4. See error
40+
validations:
41+
required: true
42+
- type: textarea
43+
id: expected
44+
attributes:
45+
label: Expected behavior
46+
description: Provide a clear and concise description of what you expected to happen.
47+
placeholder: |
48+
As a user, I expected ___ behavior but i am seeing ___
49+
validations:
50+
required: true
51+
- type: textarea
52+
id: screenshots_or_videos
53+
attributes:
54+
label: Screenshots or Videos
55+
description: |
56+
If applicable, add screenshots or a video to help explain your problem.
57+
For more information on the supported file image/file types and the file size limits, please refer
58+
to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files
59+
placeholder: |
60+
You can drag your video or image files inside of this editor ↓
61+
- type: textarea
62+
id: platform
63+
attributes:
64+
label: Platform
65+
value: |
66+
- OS: [e.g. macOS, Windows, Linux]
67+
- NodeJS: [e.g. 22.0.0]
68+
- `graphql` version: [e.g. 16.11.0]
69+
- `@graphql-codegen/*` version(s): [e.g. 5.0.3]
70+
- `graphql-codegen-typescript-mock-data` version(s): [e.g. 5.0.0]
71+
validations:
72+
required: true
73+
- type: textarea
74+
id: config
75+
attributes:
76+
label: Codegen Config File
77+
description: Your local Codegen config file (YAML/JSON...)
78+
placeholder: |
79+
schema: schema.graphql
80+
generates:
81+
mocks.ts:
82+
plugins:
83+
- typescript-mock-data
84+
85+
86+
- type: textarea
87+
id: additional
88+
attributes:
89+
label: Additional context
90+
description: Add any other context about the problem here.
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: '✨ Feature request'
2+
description: Suggest an idea for the core of this project
3+
body:
4+
- type: textarea
5+
id: description
6+
attributes:
7+
label: Is your feature request related to a problem? Please describe.
8+
description: "A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]"
9+
validations:
10+
required: true
11+
- type: textarea
12+
id: solution
13+
attributes:
14+
label: Describe the solution you'd like
15+
description: 'A clear and concise description of what you want to happen.'
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: alternatives
20+
attributes:
21+
label: Describe alternatives you've considered
22+
description: "A clear and concise description of any alternative solutions or features you've considered."
23+
validations:
24+
required: false
25+
- type: textarea
26+
id: context
27+
attributes:
28+
label: Any additional important details?
29+
description: 'Add context or screenshots about the feature request here.'
30+
validations:
31+
required: false

0 commit comments

Comments
 (0)