From f20747ead0320f84c548940a1dc2ae7c0203db76 Mon Sep 17 00:00:00 2001 From: hasan genc Date: Mon, 4 Oct 2021 14:15:20 +0300 Subject: [PATCH] Add issue template --- ISSUE_TEMPLATE/bug_report.yml | 67 ++++++++++++++++++++++++++++++ ISSUE_TEMPLATE/feature_request.yml | 46 ++++++++++++++++++++ 2 files changed, 113 insertions(+) create mode 100644 ISSUE_TEMPLATE/bug_report.yml create mode 100644 ISSUE_TEMPLATE/feature_request.yml diff --git a/ISSUE_TEMPLATE/bug_report.yml b/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..abacd34 --- /dev/null +++ b/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,67 @@ +name: "\U0001F41E Bug report" +description: Report an issue +labels: [pending triage] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: bug-description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks! + placeholder: Bug description + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Reproduction + description: Please provide a link to a repo that can reproduce the problem you ran into. A [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) is required unless you are absolutely sure that the issue is obvious and the provided information is enough to understand the problem. If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "need reproduction" label. If no reproduction is provided after 3 days, it will be auto-closed. + placeholder: Reproduction + validations: + required: true + - type: textarea + id: system-info + attributes: + label: System Info + description: Output of `npx envinfo --system --npmPackages @trendyol-js/react-carousel --binaries --browsers` + render: shell + placeholder: System, Binaries, Browsers + validations: + required: true + - type: dropdown + id: package-manager + attributes: + label: Used Package Manager + description: Select the used package manager + options: + - npm + - yarn + - pnpm + validations: + required: true + - type: textarea + id: logs + attributes: + label: Logs + description: | + Optional if provided reproduction. Please try not to insert an image but copy paste the log text. + + 1. Provide the error log here. + render: shell + - type: checkboxes + id: checkboxes + attributes: + label: Validations + description: Before submitting the issue, please make sure you do the following + options: + - label: Follow our [Code of Conduct](https://github.com/Trendyol/react-carousel/blob/master/CODE_OF_CONDUCT.md) + required: true + - label: Read the [Contributing Guidelines](https://github.com/Trendyol/react-carousel/blob/master/CONTRIBUTING.md). + required: true + - label: The provided reproduction is a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug. + required: true + +# thanks to vitejs for creating good issue templates like this! diff --git a/ISSUE_TEMPLATE/feature_request.yml b/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..c2579b0 --- /dev/null +++ b/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,46 @@ +name: "\U0001F680 New feature proposal" +description: Propose a new feature to be added to @trendyol-js/react-carousel +labels: ["enhancement: pending triage"] +body: + - type: markdown + attributes: + value: | + Thanks for your interest in the project and taking the time to fill out this feature report! + - type: textarea + id: feature-description + attributes: + label: Clear and concise description of the problem + description: "As a developer using @trendyol-js/react-carousel I want [goal / wish] so that [benefit]. If you intend to submit a PR for this issue, tell us in the description. Thanks!" + validations: + required: true + - type: textarea + id: suggested-solution + attributes: + label: Suggested solution + description: "In module [xy] we could provide following implementation..." + validations: + required: true + - type: textarea + id: alternative + attributes: + label: Alternative + description: Clear and concise description of any alternative solutions or features you've considered. + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Any other context or screenshots about the feature request here. + - type: checkboxes + id: checkboxes + attributes: + label: Validations + description: Before submitting the issue, please make sure you do the following + options: + - label: Follow our [Code of Conduct](https://github.com/Trendyol/react-carousel/blob/master/CODE_OF_CONDUCT.md) + required: true + - label: Read the [Contributing Guidelines](https://github.com/Trendyol/react-carousel/blob/master/CONTRIBUTING.md). + required: true + - label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate. + required: true + +# thanks to vitejs for creating good issue templates like this!