From 39bbbaebb37ce7a980135d1426221ff1171d8b0c Mon Sep 17 00:00:00 2001 From: ThePedroo Date: Fri, 17 Nov 2023 15:48:49 -0300 Subject: [PATCH] improve: issue templates This commit improves the issues templates using the new issue forms. --- .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md | 22 ------- .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md | 39 ------------ .github/ISSUE_TEMPLATE/feature_request.yml | 49 +++++++++++++++ .github/ISSUE_TEMPLATE/issue_template.yml | 73 ++++++++++++++++++++++ 4 files changed, 122 insertions(+), 61 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md delete mode 100644 .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/issue_template.yml diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md deleted file mode 100644 index c13cc72..0000000 --- a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: Feature request -about: Ask for new features. -assignees: '' ---- - -## Description - -Write here the description of the feature. - -## Why - -Write here why you want this feature. - -## Linked issues or PRs - -Link here any issues or PRs that are related to this issue. (OPTIONAL) - -## Checkmarks - -- [ ] This feature is not already implemented, requested or rejected. -- [ ] Follows PerformanC philosophy. diff --git a/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md deleted file mode 100644 index e6456ce..0000000 --- a/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -name: Issue -about: Report an issue. -assignees: '' ---- - -## Description - -Write here the description of the issue. - -## Reproducing - -Write here the steps to reproduce the issue. - -## Linked issues or PRs - -Link here any issues or PRs that are related to this issue. (OPTIONAL) - -## System information - -### Build on - -- Machine model: [e.g. MacBook Pro 2019, custom PC] -- OS: [e.g. Windows 11, Ubuntu 23, macOS 16] -- PerforVNM version: [e.g. 1.16.0-b.0] -- Java version: [e.g. 11.0.12] - -### Ran on - -- Machine model: [e.g. Samsung Galaxy A53, custom] -- OS: [e.g. Android 13 (API 33)] -- Architecture: [e.g. arm64-v8a, x86_64] - -OBS: You must include the machine info where you build the VN and the one you ran it. - -## Checkmarks - -- [ ] Able to reproduce on the latest PerforVNM version. -- [ ] Machines meet minimum system requirements. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..6d86125 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,49 @@ +name: Feature request +description: Ask for a new feature to be added +title: "[FR]: " +labels: ["enhancement", "not confirmed"] + +body: + - type: textarea + id: description + attributes: + label: Description + description: A clear and concise description of what the feature is. + validations: + required: true + + - type: textarea + id: reason + attributes: + label: Reason + description: Why should this feature be added? + validations: + required: true + + - type: textarea + id: example + attributes: + label: Example code + description: If you have an example of how this feature should be implemented, please share it here. + validations: + required: false + + - type: checkboxes + id: terms + attributes: + label: Confirmations + description: The following confirmations are required to open a feature request. + options: + - label: This feature is not already implemented. + required: true + - label: I have verified that this is not a duplicate feature request. + required: true + + - type: checkboxes + id: code_of_conduct + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/PerformanC/PerforVNMaker/blob/main/CODE_OF_CONDUCT.md) + options: + - label: I agree to follow this project's Code of Conduct + required: true diff --git a/.github/ISSUE_TEMPLATE/issue_template.yml b/.github/ISSUE_TEMPLATE/issue_template.yml new file mode 100644 index 0000000..4f89849 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue_template.yml @@ -0,0 +1,73 @@ +name: Issue report +description: Report an issue +title: "[BUG]: " +labels: ["bug", "not confirmed"] + +body: + - type: input + id: version + attributes: + label: PerforVNM version + description: The version of PerforVNM you're using. + validations: + required: true + + - type: input + id: platform + attributes: + label: Platform + description: The platform you're using. + validations: + required: true + + - type: input + id: platform_version + attributes: + label: Platform version + description: The version of the platform you're using. + validations: + required: true + + - type: textarea + id: description + attributes: + label: Description + description: A clear and concise description of what the bug is. + validations: + required: true + + - type: textarea + id: steps + attributes: + label: Steps to reproduce + description: Steps to reproduce the behavior. + validations: + required: true + + - type: textarea + id: example + attributes: + label: Example code + description: If you have an example of how to reproduce the bug, please share it here. + validations: + required: false + + - type: checkboxes + id: terms + attributes: + label: Confirmations + description: The following confirmations are required to open a bug report. + options: + - label: My environment meets the minimum requirements. + required: true + - label: I have verified that this is not a duplicate issue. + required: true + + - type: checkboxes + id: code_of_conduct + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/PerformanC/PerforVNMaker/blob/main/CODE_OF_CONDUCT.md) + options: + - label: I agree to follow this project's Code of Conduct + required: true