mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2025-04-02 13:45:10 -05:00
Chore: Improve Bug Report template (#859)
* Try to get architecture in BR * Move screenshots to Description * Add link to search * Specify doc page * Clarify bug report intro * Add missing period * Other missing periods for consistiency * Add line breaks, architecture req * Expand Currently... * Removing trailing quote
This commit is contained in:
parent
128594584e
commit
582629a996
35
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
35
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
@ -8,25 +8,33 @@ body:
|
|||||||
value: |
|
value: |
|
||||||
Have a question? 👉 [Start a new discussion](https://github.com/paperless-ngx/paperless-ngx/discussions/new) or [ask in chat](https://matrix.to/#/#paperless:adnidor.de).
|
Have a question? 👉 [Start a new discussion](https://github.com/paperless-ngx/paperless-ngx/discussions/new) or [ask in chat](https://matrix.to/#/#paperless:adnidor.de).
|
||||||
|
|
||||||
Before opening an issue, please check [the documentation](https://paperless-ngx.readthedocs.io/en/latest/troubleshooting.html) and see if it helps you resolve your issue. Please also make sure that you followed the installation instructions.
|
Before opening an issue, please double check:
|
||||||
|
|
||||||
If you encounter issues while installing or configuring Paperless-ngx, please post in the ["Support" section of the discussions](https://github.com/paperless-ngx/paperless-ngx/discussions/new?category=support). Remember that Paperless successfully runs on a variety of different systems. If Paperless-ngx does not start, it's likely an issue with your system, not an issue of Paperless-ngx.
|
- [The troubleshooting documentation](https://paperless-ngx.readthedocs.io/en/latest/troubleshooting.html).
|
||||||
|
- [The installation instructions](https://paperless-ngx.readthedocs.io/en/latest/setup.html#installation).
|
||||||
|
- [Existing issues and discussions](https://github.com/paperless-ngx/paperless-ngx/search?q=&type=issues).
|
||||||
|
|
||||||
Finally, please search issues and discussions before opening a new bug report.
|
If you encounter issues while installing or configuring Paperless-ngx, please post in the ["Support" section of the discussions](https://github.com/paperless-ngx/paperless-ngx/discussions/new?category=support).
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: description
|
id: description
|
||||||
attributes:
|
attributes:
|
||||||
label: Description
|
label: Description
|
||||||
description: A clear and concise description of what the bug is.
|
description: A clear and concise description of what the bug is. If applicable, add screenshots to help explain your problem.
|
||||||
placeholder: Currently...
|
placeholder: |
|
||||||
|
Currently Paperless does not work when...
|
||||||
|
|
||||||
|
[Screenshot if applicable]
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: reproduction
|
id: reproduction
|
||||||
attributes:
|
attributes:
|
||||||
label: Steps to reproduce
|
label: Steps to reproduce
|
||||||
description: Steps to reproduce the behavior
|
description: Steps to reproduce the behavior.
|
||||||
placeholder: "1. Go to '...', 2. Click on '....', 3. See error"
|
placeholder: |
|
||||||
|
1. Go to '...'
|
||||||
|
2. Click on '....'
|
||||||
|
3. See error
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
@ -35,11 +43,6 @@ body:
|
|||||||
label: Webserver logs
|
label: Webserver logs
|
||||||
description: If available, post any logs from the web server related to your issue.
|
description: If available, post any logs from the web server related to your issue.
|
||||||
render: bash
|
render: bash
|
||||||
- type: textarea
|
|
||||||
id: screenshots
|
|
||||||
attributes:
|
|
||||||
label: Screenshots
|
|
||||||
description: If applicable, add screenshots to help explain your problem.
|
|
||||||
- type: input
|
- type: input
|
||||||
id: version
|
id: version
|
||||||
attributes:
|
attributes:
|
||||||
@ -51,8 +54,8 @@ body:
|
|||||||
id: host-os
|
id: host-os
|
||||||
attributes:
|
attributes:
|
||||||
label: Host OS
|
label: Host OS
|
||||||
description: Host OS of the machine running paperless-ngx
|
description: Host OS of the machine running paperless-ngx. Please add the architecture (uname -m) if applicable.
|
||||||
placeholder: e.g. Archlinux / Ubuntu 20.04
|
placeholder: e.g. Archlinux / Ubuntu 20.04 / Raspberry Pi `arm64`
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: dropdown
|
- type: dropdown
|
||||||
@ -69,7 +72,7 @@ body:
|
|||||||
id: browser
|
id: browser
|
||||||
attributes:
|
attributes:
|
||||||
label: Browser
|
label: Browser
|
||||||
description: Which browser you are using, if relevant
|
description: Which browser you are using, if relevant.
|
||||||
placeholder: e.g. Chrome, Safari
|
placeholder: e.g. Chrome, Safari
|
||||||
- type: input
|
- type: input
|
||||||
id: config-changes
|
id: config-changes
|
||||||
@ -80,4 +83,4 @@ body:
|
|||||||
id: other
|
id: other
|
||||||
attributes:
|
attributes:
|
||||||
label: Other
|
label: Other
|
||||||
description: Any other relevant details
|
description: Any other relevant details.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user