diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index bb41a83..2fa2743 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -9,16 +9,16 @@ body: attributes: value: | **Thank you for taking the time to report a bug!** - Please fill out the following template so we can reproduce and fix the issue faster. + Please complete the form below to help us reproduce and fix the issue more effectively. - type: input id: environment attributes: label: Environment description: | - Describe where you encountered the issue. - (e.g., OS, browser, Node version, etc.) - placeholder: "Example: macOS 14.0, Chrome 125, Node.js 20.3.0" + Describe the environment where the issue occurred. + (e.g., OS, browser, Node.js version, Docker version, etc.) + placeholder: "Example: Ubuntu 22.04, Chrome 125, Node.js 20.3.0" validations: required: true @@ -27,7 +27,7 @@ body: attributes: label: Bug Description description: | - A clear and concise description of what the bug is. + A clear and concise description of the issue you encountered. placeholder: "When I do X, Y happens instead of Z..." validations: required: true @@ -37,13 +37,12 @@ body: attributes: label: Steps to Reproduce description: | - How can we reproduce the behavior? - Please list the steps in order. + Provide step-by-step instructions to reproduce the issue. placeholder: | 1. Go to '...' 2. Click on '...' 3. Scroll down to '...' - 4. See error + 4. See the error validations: required: true @@ -61,8 +60,8 @@ body: attributes: label: Screenshots or Videos description: | - If applicable, add screenshots or screen recordings to help explain your problem. - placeholder: "Attach screenshots here." + If applicable, add screenshots or screen recordings to help illustrate the issue. + placeholder: "Drag and drop or paste screenshots here." validations: required: false @@ -71,8 +70,8 @@ body: attributes: label: Logs description: | - If applicable, paste logs or error messages here. - Please remove any sensitive information. + If applicable, paste any relevant logs or error messages. + Please remove sensitive information before submitting. render: shell placeholder: | ``` @@ -86,9 +85,9 @@ body: id: terms attributes: label: Checklist - description: Before submitting, please confirm: + description: Please confirm the following before submitting: options: - - label: I have searched existing issues to avoid duplicates. + - label: I have searched existing issues to avoid creating duplicates. required: true - - label: I have provided enough information for reproduction. + - label: I have provided sufficient information to reproduce the issue. required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index ec4bb38..a49eab2 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1 +1 @@ -blank_issues_enabled: false \ No newline at end of file +blank_issues_enabled: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 90423a9..5c9b4e6 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -15,8 +15,7 @@ body: id: description attributes: label: Feature Description - description: | - A clear and concise description of the feature you’d like to see. + description: A clear and concise description of the feature you’d like to see. placeholder: "I would like to have..." validations: required: true @@ -25,8 +24,7 @@ body: id: motivation attributes: label: Motivation - description: | - Please explain why this feature would be useful. + description: Please explain why this feature would be useful. placeholder: "This feature would help because..." validations: required: true @@ -35,8 +33,7 @@ body: id: alternatives attributes: label: Alternatives Considered - description: | - Have you considered any alternative solutions or workarounds? + description: Have you considered any alternative solutions or workarounds? placeholder: "I have tried..." validations: required: false @@ -45,8 +42,7 @@ body: id: additional attributes: label: Additional Context - description: | - Add any other context or screenshots about the feature request here. + description: Add any other context or screenshots about the feature request here. placeholder: "Links to related issues or references..." validations: required: false diff --git a/.github/ISSUE_TEMPLATE/ask_for_help.yml b/.github/ISSUE_TEMPLATE/question.yml similarity index 50% rename from .github/ISSUE_TEMPLATE/ask_for_help.yml rename to .github/ISSUE_TEMPLATE/question.yml index 54e72f7..4b20107 100644 --- a/.github/ISSUE_TEMPLATE/ask_for_help.yml +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -1,5 +1,5 @@ name: ❓ Ask for Help -description: Ask a question or request guidance about this project. +description: Ask a question or request guidance related to this project. title: "[Question]: " labels: [question] assignees: [] @@ -8,8 +8,8 @@ body: - type: markdown attributes: value: | - **Thank you for reaching out!** - Please fill out this form to help us understand your question. + **Thanks for reaching out!** + Please provide as much detail as possible so we can better assist you. - type: textarea id: question @@ -17,17 +17,17 @@ body: label: What do you need help with? description: Clearly describe your question or what you're trying to achieve. placeholder: | - I am trying to do X but I'm not sure how to... + I am trying to do X, but I'm not sure how to... validations: required: true - type: textarea id: context attributes: - label: Context + label: Additional Context description: | - Provide any additional context, related issues, or links that help explain your question. - placeholder: "Related issues, pull requests, or documentation..." + Provide any relevant context, related issues, pull requests, or documentation links that could help us understand your question better. + placeholder: "Mention related issues, links to docs, or previous discussions..." validations: required: false @@ -36,8 +36,8 @@ body: attributes: label: Environment Details description: | - If applicable, please provide details about your environment (OS, Node version, browser, etc.). - placeholder: "Example: Ubuntu 22.04, Node.js v20, Chrome 125" + If relevant, provide details about your environment (e.g., OS, browser, Node.js version). + placeholder: "Example: Windows 11, Node.js v20.3.0, Firefox 125" validations: required: false @@ -45,9 +45,9 @@ body: id: checklist attributes: label: Checklist - description: Before submitting, please confirm: + description: Before submitting, please confirm the following: options: - - label: I have searched existing issues and discussions. + - label: I have searched existing issues and discussions for a solution. required: true - - label: I have read the documentation. + - label: I have read the relevant documentation. required: true