Skip to content

Commit

Permalink
bug-report-template: add an issue template for bug report
Browse files Browse the repository at this point in the history
Signed-off-by: Liang Deng <283304489@qq.com>
  • Loading branch information
YTGhost committed Apr 25, 2023
1 parent 025074b commit 02503d9
Showing 1 changed file with 83 additions and 0 deletions.
83 changes: 83 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report_template.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
name: Bug Report
description: Report a bug encountered while operating Tetragon
labels: ["kind/bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report! If you have usage questions, please join the [Cilium Slack](https://slack.cilium.io/) and ask questions in the [Tetragon channel](https://cilium.slack.com/archives/C03EV7KJPJ9). Or you could see the [FAQ](https://github.com/cilium/tetragon#faq) first.
**Important**: For security related issues: We strongly encourage you to report security vulnerabilities [here](https://github.com/cilium/tetragon/security/advisories/new) - first, before disclosing them in any public forums.
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: |
1. In this environment...
2. With this config...
3. Run '...'
4. See error...
value: "A bug happened!"
validations:
required: true
- type: textarea
id: tetra-version
attributes:
label: Tetragon Version
description: What version of the software was running when you discovered this issue? (run `tetra version`)
validations:
required: true
- type: textarea
id: kernel-version
attributes:
label: Kernel Version
description: Which kernel version was Cilium running on? (run `uname -a`)
validations:
required: true
- type: textarea
id: k8s-version
attributes:
label: Kubernetes Version
description: Which Kubernetes version are you running? (run `kubectl version`)
validations:
required: false
- type: textarea
id: bugtool
attributes:
label: Bugtool
description: |
- [About tetra CLI](https://github.com/cilium/tetragon#tetra-cli).
- Run `tetra bugtool` command
placeholder: |
Upload the output file here
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will provide more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
- 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/cilium/tetragon/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true

0 comments on commit 02503d9

Please sign in to comment.