docker-mailserver/.github/ISSUE_TEMPLATE/bug_report.yml

172 lines
7.2 KiB
YAML

name: Bug report
description: File a bug report
title: "[BUG] "
labels:
- kind/bug
- meta/needs triage
- priority/medium
body:
- type: markdown
attributes:
value: |
# Filing a report
Thank you for participating in this project and reporting a bug. Docker Mail Server (DMS) is a community-driven project, and each contribution counts.
Please **fill out all the fields and checkboxes of this form** to make it easier for maintainers to understand the problem and to solve it. The maintainers and moderators are volunteers that need you to fill this template with accurate informations in order to help you in the best and quickest way. We will have to label your request with `meta/no template - no support` if your request is sloppy and provides no way to help you correctly.
**Make sure** you read through the whole [README](https://github.com/docker-mailserver/docker-mailserver/blob/master/README.md), the [documentation](https://docker-mailserver.github.io/docker-mailserver/edge/) and the [issue tracker](https://github.com/docker-mailserver/docker-mailserver/issues?q=is%3Aissue) before opening a new bug report.
## Levels of support
We provide official support for
1. OS/ARCH: Linux on amd64/x86_64 or ARMv7 or ARM64
2. Containerization platform: Docker and Docker Compose (i.e. based on Docker Engine)
Other configurations are not officially supported, but there are maintainers that may be able to help you. This is the case for
1. OS/ARCH: macOS
2. Containerization platform: Kubernetes (K8s)
Support for these cases is dependent on specific maintainers, and these cases are marked with `not officially supported`. All other cases are not supported and there are very likely no maintainers that can help you. These cases are marked with `unsupported`.
- type: checkboxes
id: miscellaneous-first-checks
attributes:
label: Miscellaneous first 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
- type: input
id: affected-components
attributes:
label: Affected Component(s)
description: What is affected by this bug? Please describe it with only a few words here. Detailed description can be given later.
placeholder: No debug output is shown.
validations:
required: true
- type: textarea
id: when-does-it-occur
attributes:
label: What happened and when does this occur?
description: Tell us what happened. 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: Although `LOG_LEVEL=debug` is set, I see no debug output.
render: Markdown
validations:
required: true
- type: textarea
id: what-did-you-expect-to-happen
attributes:
label: What did you expect to happen?
description: Tell us what you expected.
placeholder: I expected to see debug messages.
render: Markdown
validations:
required: true
- type: textarea
id: how-do-we-replicate-this-issue
attributes:
label: How do we replicate the issue?
description: What did you do and how can we replicate this issue?
value: |
1.
2.
3.
...
render: Markdown
validations:
required: true
- type: input
id: mailserver-version
attributes:
label: DMS version
description: On which version (image tag) did you encounter this bug?
placeholder: v10.1.2
validations:
required: true
- type: dropdown
id: operating-system
attributes:
label: What operating system is DMS running on?
options:
- Linux
- macOS (not officially supported)
- Windows (unsupported)
- Other (unsupported)
validations:
required: true
- type: dropdown
id: isa
attributes:
label: What instruction set architecture is DMS running on?
options:
- x86_64 / AMD64
- ARM64 / ARM v8 (and newer)
- ARM v7
- Other (unsupported)
validations:
required: true
- type: dropdown
id: container-orchestrator
attributes:
label: What container orchestration tool are you using?
options:
- Docker
- Docker Compose
- Podman (not officially supported)
- Kubernetes (not officially supported)
- Other (unsupported)
validations:
required: true
- type: textarea
id: important-environment-variables
attributes:
label: docker-compose.yml
description: Show us your docker-compose.yml file or your equivalent "docker run" command.
render: yml
- type: textarea
id: relevant-log-output
attributes:
label: Relevant log output
description: Show us relevant log output here. You can enable debug output by setting the environment variable `LOG_LEVEL` to `debug` or `trace`.
render: bash
- type: textarea
id: other-relevant-information
attributes:
label: Other relevant information
description: If there is more, you can tell us here. Make sure to use Markdown formatting here.
render: Markdown
- type: checkboxes
id: experience
attributes:
label: What level of experience do you have with Docker and mail servers?
description: >
**You are not obliged to answer this question**.
We do encourage answering though as it provides context to better assist you.
Less experienced users tend to make common mistakes, which is ok; by letting us know we can spot those more easily.
options:
- label: I am inexperienced with docker
- label: I am inexperienced with mail servers
- label: I am uncomfortable with the CLI
- type: checkboxes
id: terms-code-of-conduct
attributes:
label: Code of conduct
description: By submitting this issue, you agree to follow [our code of conduct](https://github.com/docker-mailserver/docker-mailserver/blob/master/CODE_OF_CONDUCT.md).
options:
- label: I have read this project's [Code of Conduct](https://github.com/docker-mailserver/docker-mailserver/blob/master/CODE_OF_CONDUCT.md) and I agree
required: true
- label: I have read the [README](https://github.com/docker-mailserver/docker-mailserver/blob/master/README.md) and the [documentation](https://docker-mailserver.github.io/docker-mailserver/edge/) and I searched the [issue tracker](https://github.com/docker-mailserver/docker-mailserver/issues?q=is%3Aissue) but could not find a solution
required: true
- type: textarea
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.
render: Markdown