Skip to content

Commit

Permalink
docs:github issue template
Browse files Browse the repository at this point in the history
Github Issue Templates

Rework Github Template Issues
  • Loading branch information
jmxnzo authored and jmxnzo committed Nov 12, 2024
1 parent 579e51f commit c462a30
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 0 deletions.
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Bug report
description: File a bug report to help us improve
labels: ["bug", "needs-triage"]
body:
- type: markdown
attributes:
value: |
####
Before starting a bug report, please take a look into the [Troubleshooting Documentation](https://docs.edgeless.systems/contrast/troubleshooting) and revise the existing issue.
Further please ensure that the provided CLI logs are configured with the `--log-level` command-line flag set to `debug`.
Thanks for taking the time to fill out this bug report!
- type: input
id: version
attributes:
label: Contrast Version
description: "In which version do you encounter this bug? (Output of `contrast version`) "
placeholder: "v0.0.0"
validations:
required: true
- type: input
id: platform
attributes:
label: Deployment Platform
description: "On which platform do you encounter this bug? (Value of default_platform value in justfile.env)"
placeholder: "AKS-CLH-SNP"
validations:
required: true

- type: textarea
attributes:
label: Issue Description + Logs
description: A concise description of what you're experiencing. Please append the CLI logs(`--log-level debug`) of the encountered issue right here.
validations:
required: true

- type: textarea
attributes:
label: Steps to Reproduce The Behavior
description: Please provide a step-by-step guide on how to reproduce the issue.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Having trouble or questions?
url: https://github.com/edgelesssys/contrast/discussions/new?category=q-a
about: Open a discussion instead! We will be happy to help you.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Feature request
description: Suggest an idea for this project
body:
- type: textarea
attributes:
label: Use case
description: A concise description of what you want to happen.
validations:
required: true
- type: textarea
attributes:
label: Describe your solution
description: In case you have an idea how to implement this feature.
- type: checkboxes
attributes:
label: Would you be willing to implement this feature?
options:
- label: Yes, I could contribute this feature.

0 comments on commit c462a30

Please sign in to comment.