mirror of
https://github.com/docker-mailserver/docker-mailserver.git
synced 2024-01-19 02:48:50 +00:00
GitHub/CI: issue templates improvements (#3225)
This commit is contained in:
Georg Lauterbach
GitHub
parent
637d27efc7
commit
e4543da4d5
34
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
34
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
|
|
@ -1,10 +1,9 @@
|
|||
name: Bug report
|
||||
description: File a bug report
|
||||
title: "[BUG] "
|
||||
title: '[BUG] '
|
||||
labels:
|
||||
- kind/bug
|
||||
- meta/needs triage
|
||||
- priority/medium
|
||||
- kind/bug/report
|
||||
- meta/bug/needs triage
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
|
|
@ -14,35 +13,24 @@ body:
|
|||
|
||||
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.
|
||||
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 information 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. Markdown formatting can be used in almost all text fields. The description will tell you if this is not the case for a specific field.
|
||||
|
||||
**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.
|
||||
**Make sure** you read through our [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.
|
||||
|
||||
Markdown formatting can be used in almost all text fields. The description will tell you if this is not the case for a specific field.
|
||||
|
||||
## Levels of support
|
||||
|
||||
We provide official support for
|
||||
|
||||
1. OS/ARCH: Linux on AMD64 (x86_64) and ARM64 (AArch64)
|
||||
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`.
|
||||
We provide official support for all options not marked with "not officially supported" or "unsupported". When something is "not officially supported", support for these cases is dependent on specific maintainers.
|
||||
---
|
||||
- type: checkboxes
|
||||
id: miscellaneous-first-checks
|
||||
id: preliminary-checks
|
||||
attributes:
|
||||
label: Miscellaneous first checks
|
||||
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 read 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.
|
||||
required: true
|
||||
- type: input
|
||||
id: affected-components
|
||||
attributes:
|
||||
|
|
|
|||
48
.github/ISSUE_TEMPLATE/feature_request.md
vendored
48
.github/ISSUE_TEMPLATE/feature_request.md
vendored
|
|
@ -1,48 +0,0 @@
|
|||
---
|
||||
name: "\U0001F389 Feature request"
|
||||
about: Suggest an idea for this project
|
||||
title: '[FR]'
|
||||
labels: area/enhancement, kind/feature (request), meta/needs triage, priority/low
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
# Feature Request
|
||||
|
||||
## Context
|
||||
|
||||
|
||||
|
||||
### Is your Feature Request related to a Problem?
|
||||
|
||||
|
||||
|
||||
### Describe the Solution you'd like
|
||||
|
||||
|
||||
|
||||
### Are you going to implement it?
|
||||
|
||||
<!-- Select one, remove the other and do not shorten the sentence -->
|
||||
|
||||
Yes, because I know the probability of someone else doing it is low and I can learn from it.
|
||||
|
||||
No, and I understand that it is highly likely no one will implement it. Furthermore, I understand that this issue will likely become stale and will be closed.
|
||||
|
||||
### What are you going to contribute??
|
||||
|
||||
|
||||
|
||||
## Additional context
|
||||
|
||||
### Alternatives you've considered
|
||||
|
||||
|
||||
|
||||
### Who will that Feature be useful to?
|
||||
|
||||
|
||||
|
||||
### What have you done already?
|
||||
|
||||
|
||||
70
.github/ISSUE_TEMPLATE/feature_request.yaml
vendored
Normal file
70
.github/ISSUE_TEMPLATE/feature_request.yaml
vendored
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
name: Feature Request
|
||||
description: Suggest an idea for this project
|
||||
title: '[FR] '
|
||||
labels:
|
||||
- kind/new feature
|
||||
- meta/needs triage
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Markdown formatting can be used in almost all text fields. The description will tell you if this is not the case for a specific field.
|
||||
|
||||
---
|
||||
- type: textarea
|
||||
id: context
|
||||
attributes:
|
||||
label: Context
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: relations
|
||||
attributes:
|
||||
label: Relations
|
||||
description: Is your request related to a problem?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Description
|
||||
description: Describe the solution you would like
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: Alternatives
|
||||
description: Which alternatives have you considered?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: applicable-users
|
||||
attributes:
|
||||
label: Applicable Users
|
||||
description: Who will that feature be useful to?
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: implementer
|
||||
attributes:
|
||||
label: Are you going to implement it?
|
||||
options:
|
||||
- Yes, because I know the probability of someone else doing it is low and I can learn from it.
|
||||
- No, and I understand that it is highly likely no one will implement it. Furthermore, I understand that this issue will likely become stale and will be closed.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: contribution
|
||||
attributes:
|
||||
label: What are you going to contribute?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: already-done
|
||||
attributes:
|
||||
label: Already Done
|
||||
description: Tell us what you have already done.
|
||||
validations:
|
||||
required: true
|
||||
26
.github/ISSUE_TEMPLATE/question.yml
vendored
Normal file
26
.github/ISSUE_TEMPLATE/question.yml
vendored
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
name: Other
|
||||
description: Miscellaneous questions and reports
|
||||
title: '[OTHER] '
|
||||
labels:
|
||||
- meta/help wanted
|
||||
|
||||
body:
|
||||
- type: dropdown
|
||||
id: subject
|
||||
attributes:
|
||||
label: Subject
|
||||
options:
|
||||
- I would like to contribute to the project
|
||||
- I would like to configure a not documented mail server use case
|
||||
- I would like some feedback concerning a use case
|
||||
- I have questions about TLS/SSL/STARTTLS/OpenSSL
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Description
|
||||
description: Tell us more. Markdown formatting is supported.
|
||||
validations:
|
||||
required: true
|
||||
27
.github/ISSUE_TEMPLATE/questions.md
vendored
27
.github/ISSUE_TEMPLATE/questions.md
vendored
|
|
@ -1,27 +0,0 @@
|
|||
---
|
||||
name: "❓ Question / Other"
|
||||
about: Ask a question about docker-mailserver
|
||||
title: ''
|
||||
labels: kind/question, priority/low, meta/help wanted, meta/needs triage
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
# Subject
|
||||
|
||||
<!-- Select one, remove the others -->
|
||||
|
||||
I would like to contribute to the project
|
||||
I would like to configure a not documented mail server use case
|
||||
I would like some feedback concerning a use case
|
||||
I have questions about TLS/SSL/STARTTLS/OpenSSL
|
||||
Other
|
||||
|
||||
## Description
|
||||
|
||||
<!-- When copy/pasting code, format the code with tripe backticks (`) ! -->
|
||||
|
||||
``` BASH
|
||||
# CODE GOES HERE
|
||||
|
||||
```
|
||||
Loading…
Reference in a new issue