From 6bbd5b94a1c64e2bc4f3b4f2a698807d33930acb Mon Sep 17 00:00:00 2001 From: Naveen Singh <36371707+naveensingh@users.noreply.github.com> Date: Fri, 24 Jan 2025 05:21:48 -0500 Subject: [PATCH] Update and rename bug_report.md to bug_report.yml --- .github/ISSUE_TEMPLATE/bug_report.md | 35 ---------- .github/ISSUE_TEMPLATE/bug_report.yml | 94 +++++++++++++++++++++++++++ 2 files changed, 94 insertions(+), 35 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 5a26fad..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: bug, needs triage -assignees: '' - ---- - -**Checklist** - - [ ] I can reproduce the bug on the website right now. - - [ ] I made sure that there are no existing issues - open or closed - to which I could contribute my information to. - - [ ] I have read the FAQ and my problem isn't listed. - - [ ] I have taken the time to fill in all the required details. I understand that the bug report will be dismissed otherwise. - - [ ] This issue contains only one bug. - - [ ] I have read and understood the [contribution guidelines.](https://github.com/FossifyOrg/fossifyorg.github.io/blob/main/CONTRIBUTING.md) - -**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. - -**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..14aaf70 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,94 @@ +name: Bug report +description: Create a bug report to help us improve +labels: [ "bug", "needs triage" ] +body: + - type: markdown + attributes: + value: | + ## Hi there 👋 + Thanks for helping us improve Fossify by reporting a bug! + Please fill in as much information as possible about your bug to avoid unnecessary and time-consuming back-and-forth communication. + + - type: checkboxes + id: checklist + attributes: + label: "Checklist" + options: + - label: "I can reproduce the bug with the currently live website [here](https://www.fossify.org)." + required: true + - label: "I made sure that there are **no existing issues** - [open](https://github.com/FossifyOrg/fossifyorg.github.io/issues) or [closed](https://github.com/FossifyOrg/fossifyorg.github.io/issues?q=is%3Aissue+is%3Aclosed) - to which I could contribute my information." + required: true + - label: "I made sure that there are **no existing discussions** - [open](https://github.com/FossifyOrg/fossifyorg.github.io/discussions) or [closed](https://github.com/FossifyOrg/fossifyorg.github.io/discussions?discussions_q=is%3Aclosed) - to which I could contribute my information." + required: true + - label: "**I have taken the time to fill in all the required details. I understand that the bug report will be dismissed otherwise.**" + required: true + - label: "This issue contains only one bug." + required: true + - label: "I have read and understood the [contribution guidelines](https://github.com/FossifyOrg/fossifyorg.github.io/blob/master/CONTRIBUTING.md)." + required: true + + - type: input + id: device-os-info + attributes: + label: Affected Browser/OS + description: | + What operating system and browser were you using when you encounter the bug? + placeholder: "Example: Firefox 133.0" + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to reproduce the bug + description: | + What did you do for the bug to show up? + + If you can't cause the bug to show up again reliably (and hence don't have a proper set of steps to give us), please still try to give as many details as possible on how you think you encountered the bug. + + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: | + Tell us what you expect to happen. + validations: + required: true + + - type: textarea + id: actual-behavior + attributes: + label: Actual behavior + description: | + Tell us what happens with the steps given above. + validations: + required: true + + - type: textarea + id: screen-media + attributes: + label: Screenshots/Screen recordings + description: | + A picture or video is worth a thousand words. + + If applicable, drag and drop screenshots or a screen recording to help explain your problem. If your file is too big for Github to accept, try to compress it (ZIP file), or feel free to paste a link to an image/video instead. + + - type: textarea + id: additional-information + attributes: + label: Additional information + description: | + Please provide any additional information or context that may be relevant, for example: + * browser configuration + * extensions you are using e.g. Dark Reader + * you have disabled all animations on your device + * your rabbit chewed your network cable + * ... +