Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add issue template #6

Merged
merged 1 commit into from
Jul 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 80 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
name: Bug Report
description: File a bug report to inform the community on your awesome finding!
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thank you for filling out this bug report!
- type: textarea
id: version
attributes:
label: Version of Git SHA
description: What version of the code are you running, or what git commit sha are you building from?
validations:
required: true
- type: markdown
attributes:
value: |
Environment
- type: textarea
id: os
attributes:
label: System OS
description: MacOS, Windows, Linux, etc
validations:
required: true
- type: textarea
id: tools
attributes:
label: Installed tools
description: e.g. docker, makefiles, etc.
- type: textarea
id: others
attributes:
label: Others
description: >
e.g. flag options, celestia config file changes, resources
limitation(like cpu, ram limit, swap etc.)
- type: textarea
id: steps
attributes:
label: Steps to reproduce it
description: What steps have you made to reproduce it?
placeholder: Tell us what you see!
validations:
required: true
- type: textarea
id: expectation
attributes:
label: Expected result
description: What do you expect to happen as a final result?
placeholder: Let us know what is expected
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual result
description: What do you see happened instead as a final result?
placeholder: >
This is the crucial part in detecting the root cause of the issue
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: >
Please copy and paste any relevant log(max 20 lines) output. This will
be automatically formatted into code, so no need for backticks. Or paste
gists, pastebins links here
render: Shell
- type: textarea
id: misc
attributes:
label: Notes
description: Is there anything else we need to know?
placeholder: >
Maybe, you have other ways to repro or what side effects there are if
changing steps
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Feature Request
description: >
Request a new feature to inform the community on what will be beneficial for
the project!
title: "[Feature Request]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thank you for taking your time and creating a new feature request!
- type: textarea
id: ideas
attributes:
label: Implementation ideas
description: What ideas do you have on how to implement this?
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATES_TODO/README.md

This file was deleted.