From 0987e401dabb04a53af2af688aa18339da3b83e4 Mon Sep 17 00:00:00 2001 From: rainy w/rain Date: Fri, 21 Jun 2024 05:59:00 +0700 Subject: [PATCH] add: issue, FR and PR template (#2) This commit adds the templates for issues, feature requests and pull requests. Signed-off-by: rainy w/rain --- .github/ISSUE_TEMPLATE/issue_template.yml | 49 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/pull_request.yml | 41 +++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 17 ++++++++ 3 files changed, 107 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/issue_template.yml create mode 100644 .github/ISSUE_TEMPLATE/pull_request.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/issue_template.yml b/.github/ISSUE_TEMPLATE/issue_template.yml new file mode 100644 index 0000000..a5437fd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue_template.yml @@ -0,0 +1,49 @@ +name: Issue report +description: Report an issue +title: "[BUG]: " +labels: ["bug", "not confirmed"] + +body: + - type: input + id: version + attributes: + label: Version + description: The version of the @performanc/voice 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: 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/voice/blob/main/CODE_OF_CONDUCT.md) + options: + - label: I agree to follow this project's Code of Conduct + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/pull_request.yml b/.github/ISSUE_TEMPLATE/pull_request.yml new file mode 100644 index 0000000..109deac --- /dev/null +++ b/.github/ISSUE_TEMPLATE/pull_request.yml @@ -0,0 +1,41 @@ +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: 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/voice/blob/main/CODE_OF_CONDUCT.md) + options: + - label: I agree to follow this project's Code of Conduct + required: true \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..2517a49 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,17 @@ +## Changes + +Write here about the changes you've made + +## Why + +Write here why you think this should be merged + +## Checkmarks + +- [ ] The modified functions have been tested. +- [ ] Used the same indentation as the rest of the project. +- [ ] Updated documentation (changelog). + +## Additional information + +If you have any additional information, write it here