mirror of
https://gitee.com/iresty/apisix.git
synced 2024-12-02 12:07:35 +08:00
docs: improve bug report template (#4822)
This commit is contained in:
parent
03f09127f3
commit
1cfbaa82f5
33
.github/ISSUE_TEMPLATE/bug.md
vendored
33
.github/ISSUE_TEMPLATE/bug.md
vendored
@ -1,33 +0,0 @@
|
||||
---
|
||||
name: Bug report template
|
||||
about: Please use this template for reporting suspected bugs.
|
||||
title: 'bug: '
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
### Issue description
|
||||
|
||||
### Environment
|
||||
|
||||
Bug report without environment information will be ignored or closed.
|
||||
|
||||
* apisix version (cmd: `apisix version`):
|
||||
* OS (cmd: `uname -a`):
|
||||
* OpenResty / Nginx version (cmd: `nginx -V` or `openresty -V`):
|
||||
* etcd version, if have (cmd: run `curl http://127.0.0.1:9090/v1/server_info` to get the info from server-info API):
|
||||
* apisix-dashboard version, if have:
|
||||
* luarocks version, if the issue is about installation (cmd: `luarocks --version`):
|
||||
|
||||
### Minimal test code / Steps to reproduce the issue
|
||||
|
||||
Bug report without steps to reproduce will be ignored or closed.
|
||||
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
### What's the actual result? (including assertion message & call stack if applicable)
|
||||
|
||||
### What's the expected result?
|
63
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
63
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@ -0,0 +1,63 @@
|
||||
name: "Bug report"
|
||||
description: Create a report to help us improve
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
The more information you fill in, the better we can help you.
|
||||
|
||||
- Please use English on public channel.
|
||||
- Encourage using words rather than pictures to describe errors.
|
||||
- Encourage pre-searching with keywords in the issue.
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Issue description
|
||||
description: Provide a clear and concise description of what you're running into.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: environment
|
||||
attributes:
|
||||
label: Environment
|
||||
description: Bug report without environment information will be ignored or closed.
|
||||
value: |
|
||||
- apisix version (cmd: `apisix version`):
|
||||
- OS (cmd: `uname -a`):
|
||||
- OpenResty / Nginx version (cmd: `nginx -V` or `openresty -V`):
|
||||
- etcd version, if have (cmd: run `curl http://127.0.0.1:9090/v1/server_info` to get the info from server-info API):
|
||||
- apisix-dashboard version, if have:
|
||||
- luarocks version, if the issue is about installation (cmd: `luarocks --version`):
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: steps
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
description: Bug report without steps to reproduce will be ignored or closed.
|
||||
placeholder: |
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: actual
|
||||
attributes:
|
||||
label: Actual result
|
||||
description: What's the actual result? (including assertion message & call stack if applicable).
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: Error
|
||||
attributes:
|
||||
label: Error log
|
||||
description: You can adjust the [error log level](https://github.com/apache/apisix/blob/617c325628f33961be67f61f0fa8002afc370e42/docs/en/latest/FAQ.md#how-to-change-the-log-level) and paste more related error.log.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: expected
|
||||
attributes:
|
||||
label: Expected result
|
||||
description: What's the expected result?
|
Loading…
Reference in New Issue
Block a user