Skip to content

Commit 09b4c2a

Browse files
authored
Issue template for bug report (#1019)
1 parent fd46799 commit 09b4c2a

File tree

3 files changed

+117
-0
lines changed

3 files changed

+117
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
name: '🐛 Bug report'
2+
description: Create a report to help us improve
3+
labels:
4+
- bug
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for reporting an issue :pray:.
10+
- type: dropdown
11+
id: packages
12+
attributes:
13+
label: Which packages are impacted by your issue?
14+
multiple: true
15+
# TODO: All all other packages once we move them into that monorepo
16+
options:
17+
- '@graphprotocol/graph-cli'
18+
validations:
19+
required: true
20+
- type: markdown
21+
attributes:
22+
value: |
23+
The issues on this repo are being tracked and monitored according to our [Contributor Workflow](https://github.com/graphprotocol/graph-cli/blob/main/CONTRIBUTING.md).
24+
25+
After reading the [Contributor Workflow](https://github.com/graphprotocol/graph-cli/blob/main/CONTRIBUTING.md), Check out and update the current state of this issue:
26+
27+
- [ ] 1. The issue provides a [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example), as a GitHub repository, or as a code sample.
28+
- [ ] 2. A failing test has been provided
29+
- [ ] 3. A local solution has been provided
30+
- [ ] 4. A pull request is pending review
31+
32+
The more information you fill in, the better the community can help you.
33+
- type: textarea
34+
id: description
35+
attributes:
36+
label: Describe the issue
37+
description: Provide a clear and concise description of the challenge you are running into.
38+
validations:
39+
required: true
40+
- type: input
41+
id: link
42+
attributes:
43+
label: Reproduction
44+
description: |
45+
Which website or app were you using when the bug happened?
46+
Note:
47+
- Please read these tips for providing a minimal example: https://stackoverflow.com/help/minimal-reproducible-example.
48+
placeholder: |
49+
e.g. https://codesandbox.io/...... OR Github Repo
50+
validations:
51+
required: true
52+
- type: textarea
53+
id: steps
54+
attributes:
55+
label: Steps to Reproduce the Bug or Issue
56+
description: Describe the steps we have to take to reproduce the behavior.
57+
placeholder: |
58+
1. Go to '...'
59+
2. Click on '....'
60+
3. Scroll down to '....'
61+
4. See error
62+
validations:
63+
required: true
64+
- type: textarea
65+
id: expected
66+
attributes:
67+
label: Expected behavior
68+
description: Provide a clear and concise description of what you expected to happen.
69+
placeholder: |
70+
As a user, I expected ___ behavior but i am seeing ___
71+
validations:
72+
required: true
73+
- type: textarea
74+
id: screenshots_or_videos
75+
attributes:
76+
label: Screenshots or Videos
77+
description: |
78+
If applicable, add screenshots or a video to help explain your problem.
79+
For more information on the supported file image/file types and the file size limits, please refer
80+
to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files
81+
placeholder: |
82+
You can drag your video or image files inside of this editor ↓
83+
- type: textarea
84+
id: platform
85+
attributes:
86+
label: Platform
87+
value: |
88+
- OS: [e.g. macOS, Windows, Linux]
89+
- NodeJS: [e.g. 18.5.0]
90+
- `@graphprotocol/*` version(s): [e.g. 2.6.2]
91+
validations:
92+
required: true
93+
- type: textarea
94+
id: subgraph
95+
attributes:
96+
label: Subgraph Manifest
97+
description: Your `subgraph.yaml` file or the relevant part of it.
98+
- type: textarea
99+
id: graphql
100+
attributes:
101+
label: Subgraph GraphQL Schema
102+
description: Your `schema.graphql` file or the relevant part of it.
103+
- type: textarea
104+
id: additional
105+
attributes:
106+
label: Additional context
107+
description: Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Have a question?
4+
url: https://discord.gg/vtvv7FP
5+
about: Not sure about something? need help from the community? have a question to our team? please ask and answer questions here.

.vscode/settings.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"yaml.schemas": {
3+
"https://json.schemastore.org/github-issue-config.json": ".github/ISSUE_TEMPLATE/config.yml"
4+
}
5+
}

0 commit comments

Comments
 (0)