Skip to content

Commit

Permalink
chore: add issue templates (#115)
Browse files Browse the repository at this point in the history
  • Loading branch information
mlegner authored Aug 22, 2024
1 parent afcacea commit b97995e
Show file tree
Hide file tree
Showing 4 changed files with 146 additions and 0 deletions.
74 changes: 74 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
name: Bug Report
description: File a bug report.
labels: ["bug"]
body:
- type: markdown
attributes:
value: Thanks for taking the time to report a bug! 🐞
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what you expected to happen.
placeholder: Tell us what you see, and what you expected to see.
validations:
required: true
- type: textarea
id: search
attributes:
label: Search terms
description: >
Please make sure your issue hasn't been reported before by searching for similar issues and
provide the search terms you used here.
placeholder: Please paste the content from the issue search bar.
validations:
required: true
- type: textarea
id: reproduce-steps
attributes:
label: Steps to reproduce
description: Please provide detailed steps for reproducing the issue.
placeholder: Provide a step-by-step guide on how to reproduce the issue.
value: |
Example:
1. Create an empty file: `touch empty`
2. Try to store the empty file: `walrus store empty`
validations:
required: true
- type: textarea
id: deviation-steps
attributes:
label: Deviation steps
description: If you have deviated from the
[setup instructions](https://docs.walrus.site/usage/setup.html), please describe how.
validations:
required: false
- type: textarea
id: logs
attributes:
label: Relevant log output
description: >
Please copy and paste any relevant log output.
To get detailed output, set the `RUST_LOG` environment variable as follows:
`RUST_LOG="walrus=DEBUG"`.
Your input will be automatically formatted as code, so no need for backticks.
render: shell
- type: checkboxes
id: version
attributes:
label: Version
description: >
Have you made sure that you are using the latest versions of the `walrus` binary
and the configuration?
options:
- label: My `walrus` binary and configuration are up to date.
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our
[Code of Conduct](https://github.com/MystenLabs/walrus-docs/blob/main/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct.
required: true
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Documentation Issue
description: Report an issue or potential improvement with the documentation.
labels: ["documentation"]
body:
- type: markdown
attributes:
value: Thanks for taking the time to improve the Walrus documentation!
- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of what could be improved about the
documentation.
placeholder: "It should be better documented how to ..."
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our
[Code of Conduct](https://github.com/MystenLabs/walrus-sites/blob/main/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct.
required: true
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Feature Request
description: File a feature request.
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: Thanks for taking the time to improve Walrus!
- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of the new feature and what would be the benefit.
value: "I would like to be able to ..."
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our
[Code of Conduct](https://github.com/MystenLabs/walrus-sites/blob/main/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct.
required: true
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/other.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Other Issue
description: Report any other potential improvement.
body:
- type: markdown
attributes:
value: Thanks for taking the time to improve Walrus!
- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of the issue.
placeholder: "The CI should also test ..."
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our
[Code of Conduct](https://github.com/MystenLabs/walrus-sites/blob/main/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct.
required: true

0 comments on commit b97995e

Please sign in to comment.