From 3feeff68468369f968eb60351118cd3adafe7a22 Mon Sep 17 00:00:00 2001 From: Shea Bunge Date: Fri, 29 Nov 2024 12:05:58 +1100 Subject: [PATCH] Simplify issue templates. --- .github/ISSUE_TEMPLATE/bug.yml | 114 ---------------------- .github/ISSUE_TEMPLATE/bug_report.md | 15 +-- .github/ISSUE_TEMPLATE/config.yml | 7 +- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- 4 files changed, 8 insertions(+), 130 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml deleted file mode 100644 index 14ce1184..00000000 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ /dev/null @@ -1,114 +0,0 @@ -name: "🐞 Bug Report" -description: "Did you find a bug in Code Snippets and can you reproduce it consistently? Please report it here." -labels: ["bug"] -body: - - type: markdown - attributes: - value: | - ## ⚠️ BEFORE POSTING YOUR ISSUE - ### 🐞 Please create GitHub issues only for Code Snippets Bug Reports. - #### ❌ GitHub issues should NOT BE USED FOR SUPPORT ❌. - ❔ If you have questions, need guidance, help, or general support, please use one of the following channels: - - 🌐 [Code Snippets Community](https://www.facebook.com/groups/codesnippetsplugin) The main Facebook group where all kinds of users come together to help each other. - - πŸ“„ [Documentation](https://help.codesnippets.pro/) Learn everything about our Developer-API. - - πŸ’‘ [Feature Requests](https://roadmap.codesnippets.pro/ideas) Let us know how we can make dev-life easier for you ; ) - - πŸ—ΊοΈ [Roadmap](https://roadmap.codesnippets.pro/roadmap) See what we're up to. - - ⭐ [Reviews](https://wordpress.org/plugins/code-snippets/#reviews) Please leave a review, they really make a difference for us! - - πŸ”„ [Changelog](https://wordpress.org/plugins/code-snippets/#developers) Check the latest features we released. - - πŸ’¬ [Free Support Forum](https://wordpress.org/support/plugin/code-snippets/) Get help on WordPress.org. - - πŸ’Ž If you have an active [Code Snippets Pro](https://codesnippets.pro/) license you are entitled to personal support, please see your purchase email or visit your [Code Snippets Account page](https://codesnippets.pro/account/) for details. - - ### πŸ™ Follow these best practices to help save you time - - πŸ” **Search Before Posting:** Before creating a new Bug Report, please search for similar issues to prevent creating duplicates. - - πŸ†• **Stay Up-to-date:** Make sure you are using the most recent and stable versions of [Code Snippets](https://wordpress.org/plugins/code-snippets/#developers), [Code Snippets Pro](https://codesnippets.pro/), [WordPress](https://wordpress.org/download/releases/), and your theme. - - πŸ”¬ **Isolate the problem:** Deactivate all of your plugins (except Code Snippets Free/Pro), and temporarily change your WordPress theme to [Hello theme](https://wordpress.org/themes/hello-elementor/). If this solves the problem, gradually activate your plugins and theme one by one, until you spot the conflicting plugin or theme. - - πŸ•΅οΈ **Validate Your Issue:** If the issue can't be recreated consistently or reproduced on other sites, it's likely not a bug in Code Snippets. In that case, use one of the support links above. - - 🧩 **Contact 3rd-party Support:** If the issue happens with a Code Snippets add-on, extension, compatible plugin, or integrated theme, contact their support first. We do not provide support for 3rd-party software. - - 1️⃣ **One Issue Per Thread:** If you are experiencing more than one bug, submit only **ONE ISSUE PER THREAD**, so we can properly track them and reference them without any confusion. - - ## THE ISSUE - - type: checkboxes - id: prerequisites - attributes: - label: "Prerequisites" - options: - - label: "I have searched for similar issues in both open and closed tickets and cannot find a duplicate." - required: true - - label: "The issue still exists against the latest stable version of Code Snippets." - required: true - - type: dropdown - id: bug_type - attributes: - label: "Type of Bug" - description: "What type of bug are you reporting? Please select at least one option that is affected by the issue you're reporting (acceppts multiple options)." - multiple: true - options: - - "Snippet type PHP" - - "Snippet type HTML" - - "Snippet type CSS" - - "Snippet type JS" - - "A Code Snippet" - - "Design/Styles" - - "Dependencies" - - "Code Editor" - - "Export/Import" - - "Internationalization" - - "Maintenance Mode" - - "Notes" - - "Performance" - - "Plugin Settings" - - "Privacy" - - "Product/Core" - - "Product/Pro" - - "Product/Cloud" - - "RTL" - - "Semantics" - - "SEO" - - "UI/UX" - - "Widget" - - "Workflow" - - "I'm Not Sure" - - "Unspecified" - validations: - required: true - - type: textarea - id: description - validations: - required: true - attributes: - label: "Description" - description: "Describe the problem. What caused the issue? What did you expect to happen and what actually happened? Please be as descriptive as possible. Attach screenshots, screen recordings, and related links." - - type: textarea - id: steps_to_reproduce - validations: - required: true - attributes: - label: "Steps to reproduce" - description: "List all the steps needed to reproduce the issue in detail, so we can replicate it ourselves on our own installation. Be thorough, we won't be able to reproduce it if you don't explain how." - placeholder: "1) ... 2) ... 3) ..." - - type: checkboxes - id: isolating_the_problem - attributes: - label: "Isolating the problem" - options: - - label: "This bug happens with only the Code Snippets plugin active (Free or Pro)." - - label: "This bug happens with a Blank WordPress theme active. For example: ([Hello theme](https://wordpress.org/themes/hello-elementor/))." - - label: "I can reproduce this bug consistently following the steps above." - - type: textarea - id: system_info - validations: - required: true - attributes: - label: "Comment" - description: "Please add anything else you may deem useful for us to help you." - render: markdown - - type: markdown - attributes: - value: | - - --- - ⚠️ Please follow all the instructions indicated above, and fill all the required fields with valid information. We reserve the right to close issues that do not comply with these guidelines without any warning. - - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea78..f1435a43 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -2,7 +2,7 @@ name: Bug report about: Create a report to help us improve title: '' -labels: '' +labels: ['bug'] assignees: '' --- @@ -23,16 +23,11 @@ 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] +**Environment (please complete the following information):** + - WordPress version: [e.g. 6.7.1] + - Code Snippets version: [e.g. 3.6.6] + - Code Snippets license type: [e.g. free, pro, both] - 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/config.yml b/.github/ISSUE_TEMPLATE/config.yml index e4243232..ff7bf39b 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,15 +1,12 @@ blank_issues_enabled: true contact_links: - - name: πŸš€ Feature Request - url: https://roadmap.codesnippets.pro/ideas - about: Suggest new ideas, features, or enhancements - name: ❓ Support Question url: https://help.codesnippets.pro/ about: For Code Snippets users who need assistant and have general usage questions. - - name: πŸ’Ž Premium Support - For customer only + - name: πŸ’Ž Premium Support - For customers only url: https://help.codesnippets.pro/ about: If you have an active license you are entitled to premium support. - - name: πŸ—¨οΈ Code Snippets Global Community + - name: πŸ—¨οΈ Code Snippets Facebook Community url: https://www.facebook.com/groups/codesnippetsplugin about: The main Facebook group where all kinds of users come together to help each other. - name: πŸ“š Code Snippets Documentation diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7d..ede8477e 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -2,7 +2,7 @@ name: Feature request about: Suggest an idea for this project title: '' -labels: '' +labels: ['enhancement', 'suggestion'] assignees: '' ---