From 85a20ccdcba764d83ded3de2c3f7dad7086fa6e5 Mon Sep 17 00:00:00 2001 From: Esther White Date: Wed, 13 Mar 2024 23:24:27 +0200 Subject: [PATCH] feat(docs): issue templates yml --- .github/ISSUE_TEMPLATE/bug_report.md | 38 -------------- .github/ISSUE_TEMPLATE/bug_report.yml | 59 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/feature_request.md | 20 -------- .github/ISSUE_TEMPLATE/feature_request.yml | 59 ++++++++++++++++++++++ 5 files changed, 123 insertions(+), 58 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index dd84ea7..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..112035c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,59 @@ +name: 🐛 Bug report +description: Create a bug report to help us improve AnguHashBlog +title: "Bug: " +labels: [👀 needs triage, 🐛 bug] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + attributes: + label: Steps to reproduce + description: Describe how to reproduce the behavior. + placeholder: | + 1. Go to '...' + 2. Click on '...' + 3. Scroll down to '...' + 4. See error + validations: + required: true + - type: dropdown + attributes: + multiple: true + label: Browsers + description: Select the browsers where the issue can be reproduced (that you know of). + options: + - "Chrome" + - "Firefox" + - "Safari" + - "Edge" + - "Opera" + - "Other (add additional context)" + - type: input + id: context + attributes: + label: Additional context (Is this in dev or production?) + description: Add any other context about the problem or helpful links here. + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://anguhashblog.com/code-of-conduct) + options: + - label: I agree to follow this project's Code of Conduct + required: true + - type: checkboxes + id: contribution + attributes: + label: Contributing Docs + description: If you plan on contributing code please read - [Contribution Guide](https://anguhashblog.com/contributing) + options: + - label: I agree to follow this project's Contribution Docs + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..0333e89 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: ❓ Ask a question + url: https://discord.com/invite/h3JXbADsBy + about: Ask questions about open source onboarding \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index bbcbbe7..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..4a6772b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,59 @@ +name: 🚀 Feature request +description: Suggest an idea for this project 💡 +title: "Feature: " +labels: [👀 needs triage, 💡 feature] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this feature request! + - type: dropdown + attributes: + multiple: false + label: Type of feature + description: Select the type of feature request, the lowercase should also be the PR prefix. + options: + - "✨ Feature" + - "🐛 Fix" + - "📝 Documentation" + - "🎨 Style" + - "🧑‍💻 Refactor" + - "🔥 Performance" + - "✅ Test" + - "🤖 Build" + - "🔁 CI" + - "📦 Chore" + - "⏩ Revert" + validations: + required: true + - type: textarea + attributes: + label: Current behavior + description: Is your feature request related to a problem? Please describe. + validations: + required: true + - type: textarea + attributes: + label: Suggested solution + description: Describe the solution you'd like. + - type: input + id: context + attributes: + label: Additional context + description: Add any other context about the problem or helpful links here. + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://anguhashblog.com/code-of-conduct) + options: + - label: I agree to follow this project's Code of Conduct + required: true + - type: checkboxes + id: contribution + attributes: + label: Contributing Docs + description: If you plan on contributing code please read - [Contribution Guide](https://anguhashblog.com/contributing) + options: + - label: I agree to follow this project's Contribution Docs + required: false \ No newline at end of file