From 0acfc2f7d11058ca2f01c2411063539d26274649 Mon Sep 17 00:00:00 2001 From: CanbiZ <47820557+MickLesk@users.noreply.github.com> Date: Tue, 15 Apr 2025 22:18:16 +0200 Subject: [PATCH] shrink & minimalize report templates (#3902) --- .../DISCUSSION_TEMPLATE/request-script.yml | 2 +- .github/ISSUE_TEMPLATE/bug_report.yml | 27 +++++++++---------- .github/ISSUE_TEMPLATE/config.yml | 6 ++--- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- .github/pull_request_template.md | 18 +++---------- 5 files changed, 21 insertions(+), 34 deletions(-) diff --git a/.github/DISCUSSION_TEMPLATE/request-script.yml b/.github/DISCUSSION_TEMPLATE/request-script.yml index 44ed9b147..2498b677c 100644 --- a/.github/DISCUSSION_TEMPLATE/request-script.yml +++ b/.github/DISCUSSION_TEMPLATE/request-script.yml @@ -1,4 +1,4 @@ -title: "[Script request] " +title: "[Script request]: " labels: ["enhancement"] body: - type: input diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index c3dae1a96..a9e0b9b49 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -5,16 +5,15 @@ body: - type: markdown attributes: value: | - # 🐞 **Script Issue Report** - Thank you for taking the time to report an issue! Please provide as much detail as possible to help us address the problem efficiently. - ## ⚠️ **IMPORTANT - READ FIRST** - 🔍 **Search first:** Before submitting, check if the issue has already been reported or resolved in [closed issues](https://github.com/community-scripts/ProxmoxVE/issues?q=is%3Aissue+is%3Aclosed). If found, comment on that issue instead of creating a new one. Alternatively, check the **[Discussions](https://github.com/community-scripts/ProxmoxVE/discussions)** under the *"Announcement"* or *"Guide"* categories for relevant information. - - 🛠️ **Supported environments only:** Ensure you are using a default Linux distribution. Custom setups may not be supported. - 🔎 If you encounter `[ERROR] in line 23: exit code *: while executing command "$@" > /dev/null 2>&1`, rerun the script with verbose mode before submitting the issue. - - 💡 For general questions, feature requests, or suggestions, use the [Discussions section](https://github.com/community-scripts/ProxmoxVE/discussions). - + - 📜 **Read the script:** Familiarize yourself with the script's content and its purpose. This will help you understand the issue better and provide more relevant information + + Thank you for taking the time to report an issue! Please provide as much detail as possible to help us address the problem efficiently. + + - type: input id: guidelines attributes: @@ -35,14 +34,7 @@ body: id: script_command attributes: label: 📂 What was the exact command used to execute the script? - placeholder: "e.g., bash -c \"$(wget -qLO - https://github.com/community-scripts/ProxmoxVE/raw/main/ct/zigbee2mqtt.sh)\" or \"update\"" - validations: - required: true - - - type: textarea - id: issue_description - attributes: - label: 📝 Provide a clear and concise description of the issue. + placeholder: "e.g., bash -c \"$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/ct/zigbee2mqtt.sh)\" or \"update\"" validations: required: true @@ -75,6 +67,13 @@ body: validations: required: true + - type: textarea + id: issue_description + attributes: + label: 📝 Provide a clear and concise description of the issue. + validations: + required: true + - type: textarea id: steps_to_reproduce attributes: diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 3715f849f..00fcb8ed4 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,11 +1,11 @@ blank_issues_enabled: false contact_links: - - name: 🤔 Questions and Help - url: https://github.com/community-scripts/ProxmoxVE/discussions - about: For suggestions or questions, please use the Discussions section. - name: 🌟 new Script request url: https://github.com/community-scripts/ProxmoxVE/discussions/new?category=request-script about: For feature/script requests, please use the Discussions section. + - name: 🤔 Questions and Help + url: https://github.com/community-scripts/ProxmoxVE/discussions + about: For suggestions or questions, please use the Discussions section. - name: 💻 Discord url: https://discord.gg/jsYVk5JBxq about: Join our Discord server to chat with other users in the Proxmox Helper Scripts community. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 7f065275f..036904e38 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,5 +1,5 @@ name: "✨ Feature Request" -description: "Suggest a new feature or enhancement." +description: "Suggest a new feature or enhancement. (not for script requests)" labels: ["enhancement"] body: - type: markdown diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 89b9bc47e..82aabf27f 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,8 +1,7 @@ - - + ## ✍️ Description - + ## 🔗 Related PR / Issue @@ -13,7 +12,6 @@ Link: # - [ ] **Self-review completed** – Code follows project standards. - [ ] **Tested thoroughly** – Changes work as expected. -- [ ] **No breaking changes** – Existing functionality remains intact. - [ ] **No security risks** – No hardcoded secrets, unnecessary privilege escalations, or permission issues. --- @@ -27,13 +25,3 @@ Link: # - [ ] 🌍 **Website update** – Changes to website-related JSON files or metadata. - [ ] 🔧 **Refactoring / Code Cleanup** – Improves readability or maintainability without changing functionality. - [ ] 📝 **Documentation update** – Changes to `README`, `AppName.md`, `CONTRIBUTING.md`, or other docs. - ---- - -## 🔍 Code & Security Review (**X** in brackets) - -- [ ] **Follows `Code_Audit.md` & `CONTRIBUTING.md` guidelines** - - -## 📋 Additional Information (optional) -