From 1ac7ad09353b9ed38201a0a6289b6901bd16a3d0 Mon Sep 17 00:00:00 2001 From: Ruslan Garaev Date: Sat, 1 Jun 2024 23:02:17 +0300 Subject: [PATCH] Github issue template files --- .github/ISSUE_TEMPLATE/bug_report.yml | 72 +++++++--------------- .github/ISSUE_TEMPLATE/config.yml | 0 .github/ISSUE_TEMPLATE/feature_request.yml | 33 ++++++++++ 3 files changed, 56 insertions(+), 49 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml 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 index 4e06769..6ffcb44 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,77 +1,51 @@ -name: Bug Report -description: Use this template to report a bug. -title: "[Bug]: " -labels: ["bug"] +name: Report a bug +description: Please provide a clear and concise description of the problem. body: - type: markdown attributes: value: | ## Bug Report - Please provide a clear and concise description of the problem. - + Thanks for taking the time to fill out this bug report! - type: input id: summary attributes: - label: Summary - description: Provide a general summary of the issue. - placeholder: A short summary of the bug. - value: "" + label: "Summary" + description: "Provide a general summary of the issue." + placeholder: "A short summary of the bug." + validations: required: true - - type: textarea id: steps-to-reproduce attributes: - label: Steps to Reproduce - description: Describe the steps to reproduce the issue. + label: "Steps to Reproduce" + description: "Describe the steps to reproduce the issue." placeholder: "1. Go to...\n2. Click on...\n3. Scroll down to...\n4. See error..." - value: "" + validations: required: true - - type: input id: demo-link attributes: - label: Demo Link - description: | - Provide a link to a demo on [CodeSandbox](https://codesandbox.io/) or [StackBlitz](https://stackblitz.com/) that reproduces the issue. - You can fork from an existing [Preline](https://preline.co/docs/frameworks.html) demo if needed. - placeholder: URL to the demo - value: "" + label: "Demo Link" + description: "Provide a link to a demo on [CodeSandbox](https://codesandbox.io/) or [StackBlitz](https://stackblitz.com/) that reproduces the issue.\nYou can fork from an existing [Preline](https://preline.co/docs/frameworks.html) demo if needed." + placeholder: "URL to the demo" + validations: required: true - - type: textarea id: expected-behavior attributes: - label: Expected Behavior - description: Describe what you expected to happen. - placeholder: Describe the expected behavior. - value: "" - required: false - + label: "Expected Behavior" + description: "Describe what you expected to happen." + placeholder: "Describe the expected behavior." - type: textarea id: actual-behavior attributes: - label: Actual Behavior - description: Describe what actually happened. - placeholder: Describe the actual behavior. - value: "" - required: false - - - type: input - id: environment - attributes: - label: Environment - description: Specify the environment where the issue occurred (e.g., browser, OS, etc.). - placeholder: Browser, OS, etc. - value: "" - required: false - + label: "Actual Behavior" + description: "Describe what actually happened." + placeholder: "Describe the actual behavior." - type: textarea id: screenshots attributes: - label: Screenshots - description: | - Attach any screenshots that may help explain the problem. You can upload your screenshots to an image hosting service or drag and drop them directly into a GitHub comment, and then provide the link here. - placeholder: URL to screenshots - value: "" - required: false + label: "Screenshots" + description: "Attach any screenshots that may help explain the problem. You can upload your screenshots to an image hosting service or drag and drop them directly into a GitHub comment, and then provide the link here." + placeholder: "URL to screenshots" diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..e69de29 diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..fb3665c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,33 @@ +name: Feature Request +description: Suggest a new feature or enhancement. +body: + - type: markdown + attributes: + value: | + ## Feature Request + + Please provide a detailed description of the feature you would like to see. Include as much detail as possible to help us understand your request. + - type: input + id: feature-summary + attributes: + label: "Summary" + description: "Provide a brief summary of the feature." + placeholder: "A short summary of the feature." + validations: + required: true + - type: textarea + id: detailed-description + attributes: + label: "Detailed Description" + description: "Describe the feature in detail, including why it would be useful and how it should work." + placeholder: "Provide a detailed description of the feature." + validations: + required: true + - type: textarea + id: use-cases + attributes: + label: "Use Cases" + description: "Describe specific use cases or scenarios where this feature would be beneficial." + placeholder: "Provide specific use cases or scenarios." + validations: + required: true