From d9fe1bbb74eb44096dbb496c4319e75ee23158ea Mon Sep 17 00:00:00 2001 From: Thomas Leplus Date: Sat, 20 Apr 2024 21:57:08 -0300 Subject: [PATCH] Switching to YAML templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 74 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 14 ---- .github/ISSUE_TEMPLATE/feature_request.yml | 32 ++++++++++ 3 files changed, 106 insertions(+), 14 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..144a7cc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,74 @@ +--- +name: Bug report +description: Create a bug report +title: "[Bug]: " +labels: + - bug +assignees: + - thomasleplus +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true + - type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: true + - type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: true + - type: textarea + attributes: + label: version + description: | + Version where you observed this issue + placeholder: | + vX.Y.Z + render: markdown + validations: + required: true + - type: textarea + id: logs + attributes: + label: Relevant log output + description: | + Copy and paste any relevant log output. + This will be automatically formatted into code, so no need for backticks. + Enable debug logging, either on GitHub Actions, or when running locally. + render: shell + validations: + required: true + - type: textarea + attributes: + label: Steps To Reproduce + description: | + Steps to reproduce the issue. + placeholder: | + 1. In this environment... + 1. With this config... + 1. Run '...' + 1. See error... + validations: + required: true + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 0ad0e47..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: Feature request -about: Suggest a tool to be added to the image. -title: "[FEAT]" -labels: enhancement -assignees: thomasleplus - ---- - -**Which tool would you like to see added to the image? Why is it useful?** -A clear and concise description of what the tool is and what it is used for. Ex. If I had tool X I could [...]. Please also provide a example of the command-line that you would like to run. - -**How is it installed? Does it require any configuration?** -A clear and concise description of how the tool is installed. Ideally using a package manager (apt, pip, npm...) to keep the image automatically up to date with the latest version of the tool. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..1eab998 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,32 @@ +--- +name: Feature request +description: Suggest a new feature for this project. +title: "[Feature]: " +labels: + - enhancement +assignees: + - thomasleplus +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this feature request! + - type: textarea + attributes: + label: Feature description + description: | + A clear and concise description of what the desired feature is and why it would be useful. + render: markdown + validations: + required: true + - type: textarea + attributes: + label: Anything else? + description: | + If you think that there are some implementation details to be taken into consideration, or anything that is not obvious from the previous description, please specify it here. + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + render: markdown + validations: + required: false +