From bbeb7758d6e43ee994844d757b8f90dc4094e7a7 Mon Sep 17 00:00:00 2001 From: CanbiZ <47820557+MickLesk@users.noreply.github.com> Date: Fri, 14 Mar 2025 11:00:37 +0100 Subject: [PATCH] Update PR Template --- .github/pull_request_template.md | 46 ++++++++++++++++++++++---------- 1 file changed, 32 insertions(+), 14 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index d669ec7..b05b084 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,25 +1,43 @@ -## ✍️ Description - +## 🚨 Important Notice for New Scripts +🛑 **New scripts must first be submitted to [ProxmoxVED](https://github.com/community-scripts/ProxmoxVED) for testing.** +PRs for new scripts that skip this process will be closed. -## 🔗 Related PR / Discussion / Issue +--- + +## ✍️ Description + + +## 🔗 Related PR / Issue Link: # -## ✅ Prerequisites +## ✅ Prerequisites (**X** in brackets) -Before this PR can be reviewed, the following must be completed: +- [ ] **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. -- [] **Self-review performed** – Code follows established patterns and conventions. -- [] **Testing performed** – Changes have been thoroughly tested and verified. +--- -## 🛠️ Type of Change +## 🛠️ Type of Change (**X** in brackets) -Select all that apply: +- [ ] 🐞 **Bug fix** – Resolves an issue without breaking functionality. +- [ ] ✨ **New feature** – Adds new, non-breaking functionality. +- [ ] 💥 **Breaking change** – Alters existing functionality in a way that may require updates. +- [ ] 🆕 **New script** – A fully functional and tested script or script set. +- [ ] 🌍 **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** +- [ ] **Uses correct script structure (`AppName.sh`, `AppName-install.sh`, `AppName.json`)** +- [ ] **No hardcoded credentials** -- [] 🆕 **New script** – A fully functional and tested script or script set. -- [] 🐞 **Bug fix** – Resolves an issue without breaking functionality. -- [] ✨ **New feature** – Adds new, non-breaking functionality. -- [] 💥 **Breaking change** – Alters existing functionality in a way that may require updates. ## 📋 Additional Information (optional) - +