From 3ba7c80c655073b00ba06a13f41ed4d45fbc4cc9 Mon Sep 17 00:00:00 2001 From: Kieran Lowe <11875232+kieran-lowe@users.noreply.github.com> Date: Mon, 28 Jul 2025 19:09:52 +0000 Subject: [PATCH] refactor!: transition to issue forms --- .github/ISSUE_TEMPLATE/01-bug-report.yml | 113 ++++++++++++++++++ .github/ISSUE_TEMPLATE/02-feature-request.yml | 60 ++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 35 ------ .github/ISSUE_TEMPLATE/config.yml | 22 ++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ---- 5 files changed, 195 insertions(+), 55 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/01-bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/02-feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/01-bug-report.yml b/.github/ISSUE_TEMPLATE/01-bug-report.yml new file mode 100644 index 00000000..5830dcd9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-bug-report.yml @@ -0,0 +1,113 @@ +name: Bug Report +description: Create a report to help us improve +title: "[Bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for raising a bug report! Please fill out the following template to help us understand the issue you are experiencing. + + You can view the contributing guidelines for this project at: + + - 🐛 **Bug reports & issues:** Use [GitHub Issues](https://github.com/nunocoracao/blowfish/issues) + - 💡 **Ideas for new features:** Open a discussion on [GitHub Discussions](https://github.com/nunocoracao/blowfish/discussions) + - 🙋‍♀️ **General questions:** Head to [GitHub Discussions](https://github.com/nunocoracao/blowfish/discussions) + - type: checkboxes + id: issue-check + attributes: + label: Issue Check + description: We ask that you [check existing Issues](https://github.com/nunocoracao/blowfish/issues) to see if your bug report has already been raised. + options: + - label: I have checked existing Issues and I feel this bug has not been raised + required: true + - type: textarea + id: describe-bug + attributes: + label: Describe the Bug + description: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: To Reproduce + description: | + Please provide the steps to reproduce the behaviour. + placeholder: | + 1. Go to '...' + 2. Click on '...' + 3. Scroll down to '...' + 4. *See error* + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected Behaviour + description: A clear and concise description of what you expected to happen. + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: | + If applicable, add screenshots to help explain your problem. + + *Click inside the textbox to highlight it, then you can upload screenshots by dragging them in.* + *Alternatively, you can click on "Paste, drop or click to add files" or "Add files" below the textbox.* + validations: + required: false + - type: textarea + id: platform + attributes: + label: Platform + description: | + Add information associated with the platform you are experience this bug on. + + Example: + - OS: [e.g. iOS, MacOS, Windows, Linux] + - Browser: [e.g. chrome, safari, edge, firefox] + - Version [e.g. 22, Version 138.0.3351.77] + value: | + - OS: + - Browser: + - Version: + validations: + required: true + - type: textarea + id: hugo-version + attributes: + label: Hugo Version + description: Run `hugo version` and paste the output below. + placeholder: hugo v0.147.6-0a5fd8ebb8e2ca798515e8c564c14e32db3b4127 linux/amd64 BuildDate=2025-05-27T11:17:16Z VendorInfo=gohugoio + render: console + validations: + required: true + - type: textarea + id: blowfish-version + attributes: + label: Blowfish Version + description: Log the version of Blowfish you are running. + placeholder: v2.88.1 + render: console + validations: + required: true + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: | + Add any other context about the problem here. Are there existing GitHub Issues/Discussions that you feel are related? + validations: + required: false + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/nunocoracao/blowfish?tab=coc-ov-file#readme). + options: + - label: I agree to follow this project's Code of Conduct + required: true + diff --git a/.github/ISSUE_TEMPLATE/02-feature-request.yml b/.github/ISSUE_TEMPLATE/02-feature-request.yml new file mode 100644 index 00000000..468367de --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-feature-request.yml @@ -0,0 +1,60 @@ +name: Feature Request +description: Suggest an idea for this project +title: "[Feature]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thanks for raising a feature request! Please fill out the following template to help us understand the feature you are requesting. + + You can view the contributing guidelines for this project at: + + - 🐛 **Bug reports & issues:** Use [GitHub Issues](https://github.com/nunocoracao/blowfish/issues) + - 💡 **Ideas for new features:** Open a discussion on [GitHub Discussions](https://github.com/nunocoracao/blowfish/discussions) + - 🙋‍♀️ **General questions:** Head to [GitHub Discussions](https://github.com/nunocoracao/blowfish/discussions) + - type: checkboxes + id: issue-check + attributes: + label: Issue Check + description: We ask that you [check existing Issues](https://github.com/nunocoracao/blowfish/issues) to see if your feature request has already been raised. + options: + - label: I have checked existing Issues and I feel this feature request has not been raised + required: true + - type: textarea + id: related-problem + attributes: + label: Is your feature request related to a problem? + description: A clear and concise description of what the problem is. + placeholder: Ex. I'm always frustrated when [...] + validations: + required: true + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Describe the alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: false + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here. Are there existing GitHub Issues/Discussions that you feel are related? + validations: + required: false + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/nunocoracao/blowfish?tab=coc-ov-file#readme). + options: + - label: I agree to follow this project's Code of Conduct + required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 8e7eaf1f..00000000 --- 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: '' -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] - -**Hugo & Blowfish versions** -Which version of Hugo and Blowfish are you using? - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..c85ccbf3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,22 @@ +blank_issues_enabled: true +contact_links: + - name: Contributing Guidelines + url: https://github.com/nunocoracao/blowfish/blob/main/CONTRIBUTING.md + about: Read the contributing guidelines for this project. + + - name: Blowfish Code of Conduct + url: https://github.com/nunocoracao/blowfish?tab=coc-ov-file#readme + about: View the Code of Conduct for this project. + + - name: Ideas for New Features + url: https://github.com/nunocoracao/blowfish/discussions + about: Open a discussion using GitHub Discussions. + + - name: General Questions + url: https://github.com/nunocoracao/blowfish/discussions + about: Open a discussion using GitHub Discussions. + + - name: Blowfish Homepage + url: https://blowfish.page/ + about: Visit the homepage for more information about Blowfish. + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index bbcbbe7d..00000000 --- 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.