From 1b096b679e41331854ae2fe791fcdbe2bf3c4b48 Mon Sep 17 00:00:00 2001 From: Tyrrrz <1935960+Tyrrrz@users.noreply.github.com> Date: Sat, 12 Aug 2023 21:07:26 +0300 Subject: [PATCH] Update issue forms --- .github/ISSUE_TEMPLATE/bug-report.yml | 103 +++++++++++++++++--------- .github/ISSUE_TEMPLATE/config.yml | 6 +- 2 files changed, 72 insertions(+), 37 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index f6b4044..0335369 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,42 +1,77 @@ -name: 🐞 Bug report +name: 🐛 Bug report description: Report broken functionality. labels: [bug] body: -- type: markdown - attributes: - value: | - 🧐 **Guidelines:** + - type: markdown + attributes: + value: | + ### 📖 Important - - Search through [existing issues](https://github.com/Tyrrrz/CliFx/issues?q=is%3Aissue) first to ensure that this bug has not been reported before. - - Write a descriptive title for your issue. Avoid generic or vague titles such as "Something's not working" or "A couple of problems". - - Keep your issue focused on one single problem. If you have multiple bug reports, please create separate issues for each of them. - - Provide as much context as possible in the details section. Include screenshots, screen recordings, links, references, or anything else you may consider relevant. - - If you want to ask a question instead of reporting a bug, please use [discussions](https://github.com/Tyrrrz/CliFx/discussions/new) instead. + - Avoid generic or vague titles such as "Something's not working" or "A couple of problems" — be as descriptive as possible. + - Keep your issue focused on one single problem. If you have multiple bug reports, please create separate issues for each of them. + - Issues should represent **complete and actionable** work items. If you are unsure about something or have a question, please start a [discussion](https://github.com/Tyrrrz/CliFx/discussions/new) instead. + - Remember that CliFx is an open-source project funded by the community. If you find it useful, **please consider [donating](https://tyrrrz.me/donate) to support its development**. -- type: input - attributes: - label: Version - description: Which version of CliFx does this bug affect? - placeholder: ver X.Y.Z - validations: - required: true + ___ -- type: textarea - attributes: - label: Details - description: Clear and thorough explanation of the bug. - placeholder: I was doing X expecting Y to happen, but Z happened instead. - validations: - required: true + - type: input + attributes: + label: Version + description: Which version of the package does this bug affect? + placeholder: v1.0.0 + validations: + required: true -- type: textarea - attributes: - label: Steps to reproduce - description: Minimum steps required to reproduce the bug. - placeholder: | - - Step 1 - - Step 2 - - Step 3 - validations: - required: true \ No newline at end of file + - type: input + attributes: + label: Platform + description: What platform do you experience this bug on? + placeholder: .NET 7.0 / Windows 11 + validations: + required: true + + - type: textarea + attributes: + label: Steps to reproduce + description: > + Minimum steps required to reproduce the bug, including prerequisites, code snippets, or other relevant items. + The information provided in this field must be readily actionable, meaning that anyone should be able to reproduce the bug by following these steps. + If the reproduction steps are too complex to fit in this field, please provide a link to a repository instead. + placeholder: | + - Step 1 + - Step 2 + - Step 3 + validations: + required: true + + - type: textarea + attributes: + label: Details + description: Clear and thorough explanation of the bug, including any additional information you may find relevant. + placeholder: | + - Expected behavior: ... + - Actual behavior: ... + validations: + required: true + + - type: checkboxes + attributes: + label: Checklist + description: Quick list of checks to ensure that everything is in order. + options: + - label: I have looked through existing open and closed issues to make sure that this bug has not been reported before + required: true + - label: I have provided a descriptive title for this issue + required: true + - label: I have made sure that that this bug is reproducible on the latest version of the package + required: true + - label: I have provided all the information needed to reproduce this bug as efficiently as possible + required: true + - label: I have sponsored this project + required: false + + - type: markdown + attributes: + value: | + If you are struggling to provide actionable reproduction steps, or if something else is preventing you from creating a complete bug report, please start a [discussion](https://github.com/Tyrrrz/CliFx/discussions/new) instead. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 4c3358d..824fc71 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -3,9 +3,9 @@ contact_links: - name: ⚠ Feature request url: https://github.com/Tyrrrz/.github/blob/master/docs/project-status.md about: Sorry, but this project is in maintenance mode and no longer accepts new feature requests. + - name: 🗨 Discussions + url: https://github.com/Tyrrrz/CliFx/discussions/new + about: Ask and answer questions. - name: 💬 Discord server url: https://discord.gg/2SUWKFnHSm about: Chat with the project community. - - name: 🗨 Discussions - url: https://github.com/Tyrrrz/CliFx/discussions/new - about: Ask and answer questions. \ No newline at end of file