1
1
Fork 0
mirror of https://github.com/docker-mailserver/docker-mailserver synced 2024-05-07 08:56:06 +02:00
docker-mailserver/.github/ISSUE_TEMPLATE/bug_report.yml
Brennan Kinney e68062282a
ci: Simplify GH bug report template (#3381)
Simplify the bug report form further by dropping / merging form sections.

Change Overview:
- Minor revisions and formatting changes (_multi-line pipe operator, emoji, fix typos, etc_).
- Collapsed OS + Arch into single input field (_not much benefit from the two additional dropdown items_).
- Description/reproduction and expectation sections revised (_expectation intent is typically inferred by the issue description, while detailed reproduction steps can belong a separate optional section_).
- Removed platform dropdown (_Windows and macOS are mentioned in description as unsupported_).
- Removed experience checkboxes (_context doesn't really change responses_).
- Removed the orchestrator dropdown (_we don't seem to use this information, it's just noise_)
- Relocate the DMS version + OS/Arch sections to come after the Reproduction steps.
2023-06-01 12:57:05 +12:00

88 lines
3.9 KiB
YAML

name: Bug Report
description: Submit a bug report to help us improve
title: 'bug report: '
labels:
- kind/bug/report
- meta/needs triage
body:
- type: checkboxes
id: preliminary-checks
attributes:
label: 📝 Preliminary Checks
description: Please read these carefully.
options:
- label: I checked that all ports are open and not blocked by my ISP / hosting provider.
required: true
- label: I know that SSL errors are likely the result of a wrong setup on the user side and not caused by DMS itself. I'm confident my setup is correct.
required: true
- label: I searched the issue tracker but was unable to find my issue.
required: true
- label: |
I have read:
- The [extended documentation in general](https://docker-mailserver.github.io/docker-mailserver/latest/) but found nothing to resolve the issue;
- The [documentation on debugging](https://docker-mailserver.github.io/docker-mailserver/latest/config/debugging/), tried the proposed steps to debug the problem, but was still unable to resolve the issue;
- This project's [Code of Conduct](https://github.com/docker-mailserver/docker-mailserver/blob/master/CODE_OF_CONDUCT.md) and I agree;
- The [documentation about filing a bug report](https://docker-mailserver.github.io/docker-mailserver/latest/contributing/issues-and-pull-requests/#filing-a-bug-report).
required: true
- type: textarea
id: what-happened
attributes:
label: 👀 What Happened?
description: How did this differ from your expectations?
placeholder: Although `LOG_LEVEL=debug` is set, the logs are missing debug output.
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: 👟 Reproduction Steps
description: |
How did you trigger this bug? Please walk us through it step by step.
Please use [fenced code blocks](https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#fenced-code-blocks) when pasting lots of text!
placeholder: The easier it is for us to reproduce your issue, the sooner we can help resolve it 😉
- type: input
id: mailserver-version
attributes:
label: 🐋 DMS Version
description: On which version (image tag) did you encounter this bug?
placeholder: v12.1.0
validations:
required: true
- type: input
id: operating-system
attributes:
label: 💻 Operating System and Architecture
description: |
Which OS is your docker host running on?
**NOTE:** Windows and macOS have limited support.
placeholder: Debian 11 (Bullseye) x86_64, Fedora 38 ARM64
validations:
required: true
- type: textarea
id: container-configuration-files
attributes:
label: ⚙️ Container configuration files
description: |
Show us the file that you use to run DMS (and possibly other related services).
- This field is formatted as YAML.
- This is most likely your `compose.yaml` file, but you can also show us your equivalent `docker run` command, if applicable.
- If you are using Kubernetes, you can also put your manifest files here.
render: yml
- type: textarea
id: relevant-log-output
attributes:
label: 📜 Relevant log output
description: |
Show us relevant log output here.
- This field expects only plain text (_rendered as a fenced code block_).
- You can enable debug output by setting the environment variable `LOG_LEVEL` to `debug` or `trace`.
render: Text
- type: input
id: form-improvements
attributes:
label: Improvements to this form?
description: If you have criticism or general feedback about this issue form, feel free to tell us so we can enhance the experience for everyone.
validations:
required: false