Skip to content

Commit 5c79fab

Browse files
chore(docs): Update bug-report.yml (#28)
* Update bug-report.yml * Update .github/ISSUE_TEMPLATE/bug-report.yml Co-authored-by: Matthew Sevey <15232757+MSevey@users.noreply.github.com> * Update .github/ISSUE_TEMPLATE/bug-report.yml Co-authored-by: Matthew Sevey <15232757+MSevey@users.noreply.github.com> * Update .github/ISSUE_TEMPLATE/bug-report.yml Co-authored-by: Matthew Sevey <15232757+MSevey@users.noreply.github.com> * Update .github/ISSUE_TEMPLATE/bug-report.yml Co-authored-by: Matthew Sevey <15232757+MSevey@users.noreply.github.com> * Update .github/ISSUE_TEMPLATE/bug-report.yml Co-authored-by: Matthew Sevey <15232757+MSevey@users.noreply.github.com> --------- Co-authored-by: Matthew Sevey <15232757+MSevey@users.noreply.github.com>
1 parent da0d7c3 commit 5c79fab

1 file changed

Lines changed: 90 additions & 33 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 90 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -5,76 +5,133 @@ body:
55
- type: markdown
66
attributes:
77
value: |
8-
Thank you for filling out this bug report!
8+
Thank you for filling out this bug report! Please provide as much detail as possible to help us investigate.
99
- type: textarea
1010
id: version
1111
attributes:
12-
label: Version of Git SHA
13-
description: What version of the code are you running, or what git commit sha are you building from?
12+
label: Version Information
13+
description: Please provide versions of all relevant components
14+
placeholder: |
15+
Rollkit:
16+
Go-DA:
17+
DA Implementation:
18+
Go-Sequencing:
19+
Sequencing Implementation:
20+
Go-Execution:
21+
Execution Implementation:
1422
validations:
1523
required: true
1624
- type: markdown
1725
attributes:
1826
value: |
19-
Environment
27+
Environment Details
2028
- type: textarea
2129
id: os
2230
attributes:
23-
label: System OS
24-
description: MacOS, Windows, Linux, etc
31+
label: System Information
32+
description: Provide detailed system information
33+
placeholder: |
34+
OS Type & Version:
35+
Architecture (arm64/amd64):
36+
Kernel Version (for Linux):
37+
Memory Size:
38+
Available Disk Space:
2539
validations:
2640
required: true
41+
- type: textarea
42+
id: network
43+
attributes:
44+
label: Network Configuration
45+
description: Network details if applicable
46+
placeholder: |
47+
Network Type (Testnet/Mainnet):
48+
Network ID:
49+
Chain ID:
50+
Connected Peers:
51+
P2P Port:
52+
RPC Port:
2753
- type: textarea
2854
id: tools
2955
attributes:
30-
label: Installed tools
31-
description: e.g. docker, makefiles, etc.
56+
label: Development Environment
57+
description: List all relevant tools and their versions
58+
placeholder: |
59+
Docker Version:
60+
Docker Compose Version:
61+
Make Version:
62+
NodeJS Version (if applicable):
63+
Go Version:
64+
Protobuf Verion:
65+
Rust Version (if applicable):
66+
Other Build Tools:
3267
- type: textarea
33-
id: others
68+
id: config
3469
attributes:
35-
label: Others
36-
description: >
37-
e.g. flag options, celestia config file changes, resources
38-
limitation(like cpu, ram limit, swap etc.)
70+
label: Configuration Details
71+
description: Any modifications to default configurations
72+
placeholder: |
73+
DA Implementation Config:
74+
Sequencer Implementation Config:
75+
Execution Implementation Config:
76+
Resource Limitations:
77+
Environment Variables:
78+
Command Line Flags:
79+
Custom Parameters:
3980
- type: textarea
4081
id: steps
4182
attributes:
42-
label: Steps to reproduce it
43-
description: What steps have you made to reproduce it?
44-
placeholder: Tell us what you see!
83+
label: Steps to Reproduce
84+
description: Provide detailed steps to reproduce the issue
85+
placeholder: |
86+
1. Initial setup steps
87+
2. Commands executed
88+
3. API calls made
89+
4. Expected trigger points
90+
5. Error occurrence timing
4591
validations:
4692
required: true
4793
- type: textarea
4894
id: expectation
4995
attributes:
50-
label: Expected result
51-
description: What do you expect to happen as a final result?
52-
placeholder: Let us know what is expected
96+
label: Expected Result
97+
description: What should happen when following these steps?
98+
placeholder: Include expected logs, outputs, or behaviors
5399
validations:
54100
required: true
55101
- type: textarea
56102
id: actual
57103
attributes:
58-
label: Actual result
59-
description: What do you see happened instead as a final result?
60-
placeholder: >
61-
This is the crucial part in detecting the root cause of the issue
104+
label: Actual Result
105+
description: What actually happened?
106+
placeholder: |
107+
- Describe the error/unexpected behavior
108+
- Include error messages
109+
- Note any error codes
110+
- Mention any side effects
62111
validations:
63112
required: true
64113
- type: textarea
65114
id: logs
66115
attributes:
67-
label: Relevant log output
68-
description: >
69-
Please copy and paste any relevant log(max 20 lines) output. This will
70-
be automatically formatted into code, so no need for backticks. Or paste
71-
gists, pastebins links here
116+
label: Relevant Logs
117+
description: |
118+
Please provide relevant logs from different components:
119+
- Node logs
120+
- Rollkit logs
121+
- DA logs
122+
- Sequencer logs
123+
- Execution logs
124+
- System logs
125+
Max 20 lines per component or provide gist/pastebin links
72126
render: Shell
73127
- type: textarea
74128
id: misc
75129
attributes:
76-
label: Notes
77-
description: Is there anything else we need to know?
78-
placeholder: >
79-
Maybe, you have other ways to repro or what side effects there are if
80-
changing steps
130+
label: Additional Information
131+
description: Any other relevant details
132+
placeholder: |
133+
- Alternative reproduction methods
134+
- Related issues
135+
- Recent system changes
136+
- Workarounds attempted
137+
- Impact severity

0 commit comments

Comments
 (0)