follow-up to #3225 (#3229)

Misc spelling fixes and resolved imprecise statements. Shortened the bug
report introduction a bit further and added a statement about being
precise to all templates.
This commit is contained in:
Georg Lauterbach 2023-04-07 11:58:51 +02:00 committed by GitHub
parent e4543da4d5
commit a9515b49c2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 34 additions and 29 deletions

View file

@ -1,6 +1,6 @@
name: Bug report name: Bug Report
description: File a bug report description: File a bug report
title: '[BUG] ' title: 'bug report: '
labels: labels:
- kind/bug/report - kind/bug/report
- meta/bug/needs triage - meta/bug/needs triage
@ -11,13 +11,14 @@ body:
value: | value: |
# Filing a report # 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. Thank you for participating in this project and reporting a bug. Docker Mail Server (DMS) is a community-driven project, and each contribution counts. 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.
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. 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 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. Be as precise as possible, and if in doubt, it's best to add more information that too few.
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. 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 - type: checkboxes
id: preliminary-checks id: preliminary-checks
@ -29,6 +30,10 @@ body:
required: true 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. - 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 required: true
- label: I searched the issue tracker but was unable to find my issue.
required: true
- label: I read the [extended documentation in general](https://docker-mailserver.github.io/docker-mailserver/latest/) but found nothing to resolve the issue.
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. - 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 required: true
- type: input - type: input

View file

@ -1,9 +1,12 @@
blank_issues_enabled: false blank_issues_enabled: false
contact_links: contact_links:
- name: Documentation - name: Documentation | Landing Page
url: https://docker-mailserver.github.io/docker-mailserver/edge url: https://docker-mailserver.github.io/docker-mailserver/latest
about: Extended documentaton - visit this first before opening issues about: Visit this first before opening issues!
- name: Environment Variables Section - name: Documentation | Environment Variables Page
url: https://docker-mailserver.github.io/docker-mailserver/edge/config/environment/ url: https://docker-mailserver.github.io/docker-mailserver/latest/config/environment/
about: Read this section for information about mail server variables about: Read this page for information about mail server variables.
- name: Documentation | Debugging Page
url: https://docker-mailserver.github.io/docker-mailserver/latest/config/debugging/
about: Read this page for information on how to debug DMS.

View file

@ -1,6 +1,6 @@
name: Feature Request name: Feature Request
description: Suggest an idea for this project description: Suggest an idea for this project
title: '[FR] ' title: 'feature request: '
labels: labels:
- kind/new feature - kind/new feature
- meta/needs triage - meta/needs triage
@ -11,25 +11,21 @@ body:
value: | 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. 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.
Be as precise as possible, and if in doubt, it's best to add more information that too few.
--- ---
- type: textarea - type: textarea
id: context id: context
attributes: attributes:
label: Context label: Context
validations: description: Tell us how your request is related to DMS, one of its components or another issue / PR. Also **link all conected issues and PRs here**!
required: true
- type: textarea
id: relations
attributes:
label: Relations
description: Is your request related to a problem?
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: description id: description
attributes: attributes:
label: Description label: Description
description: Describe the solution you would like description: Describe the solution you would like to have implemented. Be as precise as possible!
validations: validations:
required: true required: true
- type: textarea - type: textarea
@ -59,12 +55,6 @@ body:
id: contribution id: contribution
attributes: attributes:
label: What are you going to contribute? label: What are you going to contribute?
validations: description: You may also tell us what you have already done.
required: true
- type: textarea
id: already-done
attributes:
label: Already Done
description: Tell us what you have already done.
validations: validations:
required: true required: true

View file

@ -1,10 +1,18 @@
name: Other name: Other
description: Miscellaneous questions and reports description: Miscellaneous questions and reports
title: '[OTHER] ' title: 'other: '
labels: labels:
- meta/help wanted - meta/help wanted
body: 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.
Be as precise as possible, and if in doubt, it's best to add more information that too few.
---
- type: dropdown - type: dropdown
id: subject id: subject
attributes: attributes:
@ -21,6 +29,5 @@ body:
id: description id: description
attributes: attributes:
label: Description label: Description
description: Tell us more. Markdown formatting is supported.
validations: validations:
required: true required: true