diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 3944a0bb..723e1f97 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,6 +1,6 @@ -name: Bug report +name: Bug Report description: File a bug report -title: '[BUG] ' +title: 'bug report: ' labels: - kind/bug/report - meta/bug/needs triage @@ -11,13 +11,14 @@ body: 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. + 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. + --- - type: checkboxes id: preliminary-checks @@ -29,6 +30,10 @@ body: 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 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. required: true - type: input diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index c1efca2e..d5d80621 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,9 +1,12 @@ blank_issues_enabled: false contact_links: - - name: Documentation - url: https://docker-mailserver.github.io/docker-mailserver/edge - about: Extended documentaton - visit this first before opening issues - - name: Environment Variables Section - url: https://docker-mailserver.github.io/docker-mailserver/edge/config/environment/ - about: Read this section for information about mail server variables + - name: Documentation | Landing Page + url: https://docker-mailserver.github.io/docker-mailserver/latest + about: Visit this first before opening issues! + - name: Documentation | Environment Variables Page + url: https://docker-mailserver.github.io/docker-mailserver/latest/config/environment/ + 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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index a45f13b4..0ee66a03 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -1,6 +1,6 @@ name: Feature Request description: Suggest an idea for this project -title: '[FR] ' +title: 'feature request: ' labels: - kind/new feature - meta/needs triage @@ -11,25 +11,21 @@ body: 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: textarea id: context attributes: label: Context - validations: - required: true - - type: textarea - id: relations - attributes: - label: Relations - description: Is your request related to a problem? + 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**! validations: required: true - type: textarea id: description attributes: 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: required: true - type: textarea @@ -59,12 +55,6 @@ body: 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. + description: You may also tell us what you have already done. validations: required: true diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml index d13f040c..7a743511 100644 --- a/.github/ISSUE_TEMPLATE/question.yml +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -1,10 +1,18 @@ name: Other description: Miscellaneous questions and reports -title: '[OTHER] ' +title: 'other: ' labels: - meta/help wanted 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 id: subject attributes: @@ -21,6 +29,5 @@ body: id: description attributes: label: Description - description: Tell us more. Markdown formatting is supported. validations: required: true