Add GitHub templates and configuration (#8)
- Add CODEOWNERS file for code review assignments - Add bug report issue template - Add feature request issue template - Add pull request template
This commit is contained in:
committed by
GitHub
parent
1557d589cf
commit
5823e54464
15
.github/CODEOWNERS
vendored
Normal file
15
.github/CODEOWNERS
vendored
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
#
|
||||||
|
# CODEOWNERS for ProxmoxVE
|
||||||
|
#
|
||||||
|
|
||||||
|
# Order is important; the last matching pattern takes the most
|
||||||
|
# precedence.
|
||||||
|
|
||||||
|
|
||||||
|
# Codeowners for specific folders and files
|
||||||
|
# Remember ending folders with /
|
||||||
|
|
||||||
|
|
||||||
|
# Set default reviewers
|
||||||
|
* @community-scripts/Contributor
|
||||||
|
|
||||||
50
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
50
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
name: "🐞 Script Issue Report"
|
||||||
|
description: Report a specific issue.
|
||||||
|
labels: ["bug"]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
## ⚠️ **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-Local/issues?q=is%3Aissue+is%3Aclosed). If found, comment on that issue instead of creating a new one.
|
||||||
|
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:
|
||||||
|
label: ✅ Have you read and understood the above guidelines?
|
||||||
|
placeholder: "yes"
|
||||||
|
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:
|
||||||
|
label: 🔄 Steps to reproduce the issue.
|
||||||
|
placeholder: "e.g., Step 1: ..., Step 2: ..."
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: error_output
|
||||||
|
attributes:
|
||||||
|
label: ❌ Paste the full error output (if available).
|
||||||
|
placeholder: "Include any relevant logs or error messages."
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: additional_context
|
||||||
|
attributes:
|
||||||
|
label: 🖼️ Additional context (optional).
|
||||||
|
placeholder: "Include screenshots, code blocks (use triple backticks ```), or any other relevant information."
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
33
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
33
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
name: "✨ Feature Request"
|
||||||
|
description: "Suggest a new feature or enhancement."
|
||||||
|
labels: ["enhancement"]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
# ✨ **Feature Request**
|
||||||
|
Have an idea for a new feature? Share your thoughts below!
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: feature_summary
|
||||||
|
attributes:
|
||||||
|
label: "🌟 Briefly describe the feature"
|
||||||
|
placeholder: "e.g., Add support for XYZ"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: feature_description
|
||||||
|
attributes:
|
||||||
|
label: "📝 Detailed description"
|
||||||
|
placeholder: "Explain the feature in detail"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: use_case
|
||||||
|
attributes:
|
||||||
|
label: "💡 Why is this useful?"
|
||||||
|
placeholder: "Describe the benefit of this feature"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
24
.github/pull_request_template.md
vendored
Normal file
24
.github/pull_request_template.md
vendored
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
<!--🛑 All Pull Requests need to made against the development branch. PRs against main will get closed. -->
|
||||||
|
## ✍️ Description
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## 🔗 Related PR / Issue
|
||||||
|
Link: #
|
||||||
|
|
||||||
|
|
||||||
|
## ✅ Prerequisites (**X** in brackets)
|
||||||
|
|
||||||
|
- [ ] **Self-review completed** – Code follows project standards.
|
||||||
|
- [ ] **Tested thoroughly** – Changes work as expected.
|
||||||
|
- [ ] **No security risks** – No hardcoded secrets, unnecessary privilege escalations, or permission issues.
|
||||||
|
|
||||||
|
## Screenshot for frontend Change
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🛠️ Type of Change (**X** in brackets)
|
||||||
|
|
||||||
|
- [ ] 🐞 **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.
|
||||||
Reference in New Issue
Block a user