diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..27f8c89 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,91 @@ +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema +name: Bug Report +description: Report a bug +labels: + - kind/bug + - status/triage + +body: + - type: checkboxes + attributes: + label: Support guidelines + description: Please read the support guidelines before proceeding. + options: + - label: I've read the [support guidelines](https://github.com/crazy-max/docker-rrdcached/blob/master/.github/SUPPORT.md) + required: true + + - type: checkboxes + attributes: + label: I've found a bug and checked that ... + description: | + Make sure that your request fulfills all of the following requirements. If one requirement cannot be satisfied, explain in detail why. + options: + - label: ... the documentation does not mention anything about my problem + - label: ... there are no open or closed issues that are related to my problem + + - type: textarea + attributes: + label: Description + description: | + Please provide a brief description of the bug in 1-2 sentences. + validations: + required: true + + - type: textarea + attributes: + label: Expected behaviour + description: | + Please describe precisely what you'd expect to happen. + validations: + required: true + + - type: textarea + attributes: + label: Actual behaviour + description: | + Please describe precisely what is actually happening. + validations: + required: true + + - type: textarea + attributes: + label: Steps to reproduce + description: | + Please describe the steps to reproduce the bug. + placeholder: | + 1. ... + 2. ... + 3. ... + validations: + required: true + + - type: textarea + attributes: + label: Docker info + description: | + Output of `docker info` command. + render: text + validations: + required: true + + - type: textarea + attributes: + label: Docker Compose config + description: | + Output of `docker compose config` command. + render: yaml + + - type: textarea + attributes: + label: Logs + description: | + Please provide the container logs (set `LOG_LEVEL=debug` if applicable). + render: text + validations: + required: true + + - type: textarea + attributes: + label: Additional info + description: | + Please provide any additional information that seem useful. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 0435112..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve ---- - -### Behaviour - -#### Steps to reproduce this issue - -1. -2. -3. - -#### Expected behaviour - -> Tell me what should happen - -#### Actual behaviour - -> Tell me what happens instead - -### Configuration - -* Docker version (type `docker --version`) : -* Docker compose version if applicable (type `docker-compose --version`) : -* Platform (Debian 9, Ubuntu 18.04, ...) : -* System info (type `uname -a`) : -* Include all necessary configuration files : `docker-compose.yml`, `.env`, ... - -### Docker info - -``` -> Output of command `docker info` -``` - -### Logs - -``` -> Container logs (set LOG_LEVEL to debug if applicable) -``` diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..d679047 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,6 @@ +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser +blank_issues_enabled: true +contact_links: + - name: Questions and Discussions + url: https://github.com/crazy-max/docker-rrdcached/discussions/new + about: Use Github Discussions to ask questions and/or open discussion topics. diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..6ab7568 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,15 @@ +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema +name: Feature request +description: Missing functionality? Come tell us about it! +labels: + - kind/enhancement + - status/triage + +body: + - type: textarea + id: description + attributes: + label: Description + description: What is the feature you want to see? + validations: + required: true