Skip to content

Commit 5823e54

Browse files
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
1 parent 1557d58 commit 5823e54

File tree

4 files changed

+122
-0
lines changed

4 files changed

+122
-0
lines changed

β€Ž.github/CODEOWNERSβ€Ž

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#
2+
# CODEOWNERS for ProxmoxVE
3+
#
4+
5+
# Order is important; the last matching pattern takes the most
6+
# precedence.
7+
8+
9+
# Codeowners for specific folders and files
10+
# Remember ending folders with /
11+
12+
13+
# Set default reviewers
14+
* @community-scripts/Contributor
15+
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: "🐞 Script Issue Report"
2+
description: Report a specific issue.
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## ⚠️ **IMPORTANT - READ FIRST**
9+
- πŸ” **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.
10+
Thank you for taking the time to report an issue! Please provide as much detail as possible to help us address the problem efficiently.
11+
12+
13+
- type: input
14+
id: guidelines
15+
attributes:
16+
label: βœ… Have you read and understood the above guidelines?
17+
placeholder: "yes"
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: issue_description
23+
attributes:
24+
label: πŸ“ Provide a clear and concise description of the issue.
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: steps_to_reproduce
30+
attributes:
31+
label: πŸ”„ Steps to reproduce the issue.
32+
placeholder: "e.g., Step 1: ..., Step 2: ..."
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: error_output
38+
attributes:
39+
label: ❌ Paste the full error output (if available).
40+
placeholder: "Include any relevant logs or error messages."
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: additional_context
46+
attributes:
47+
label: πŸ–ΌοΈ Additional context (optional).
48+
placeholder: "Include screenshots, code blocks (use triple backticks ```), or any other relevant information."
49+
validations:
50+
required: false
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: "✨ Feature Request"
2+
description: "Suggest a new feature or enhancement."
3+
labels: ["enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
# ✨ **Feature Request**
9+
Have an idea for a new feature? Share your thoughts below!
10+
11+
- type: input
12+
id: feature_summary
13+
attributes:
14+
label: "🌟 Briefly describe the feature"
15+
placeholder: "e.g., Add support for XYZ"
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
id: feature_description
21+
attributes:
22+
label: "πŸ“ Detailed description"
23+
placeholder: "Explain the feature in detail"
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: use_case
29+
attributes:
30+
label: "πŸ’‘ Why is this useful?"
31+
placeholder: "Describe the benefit of this feature"
32+
validations:
33+
required: true
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!--πŸ›‘ All Pull Requests need to made against the development branch. PRs against main will get closed. -->
2+
## ✍️ Description
3+
4+
5+
6+
## πŸ”— Related PR / Issue
7+
Link: #
8+
9+
10+
## βœ… Prerequisites (**X** in brackets)
11+
12+
- [ ] **Self-review completed** – Code follows project standards.
13+
- [ ] **Tested thoroughly** – Changes work as expected.
14+
- [ ] **No security risks** – No hardcoded secrets, unnecessary privilege escalations, or permission issues.
15+
16+
## Screenshot for frontend Change
17+
18+
---
19+
20+
## πŸ› οΈ Type of Change (**X** in brackets)
21+
22+
- [ ] 🐞 **Bug fix** – Resolves an issue without breaking functionality.
23+
- [ ] ✨ **New feature** – Adds new, non-breaking functionality.
24+
- [ ] πŸ’₯ **Breaking change** – Alters existing functionality in a way that may require updates.

0 commit comments

Comments
Β (0)