Skip to content

Commit c0cf76f

Browse files
authored
Github: Optimize Issue Template & PR Template (#802)
* Update bug_report.yml * Update bug_report.yml * Update bug_report.yml * Update bug_report.yml * Update pull_request_template.md
1 parent 77d2df5 commit c0cf76f

File tree

2 files changed

+77
-40
lines changed

2 files changed

+77
-40
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 49 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,44 +5,64 @@ body:
55
- type: markdown
66
attributes:
77
value: |
8-
**IMPORTANT:** Failure to comply with the following guidelines may result in immediate closure.
9-
- Prior to submitting, kindly search the closed issues to check if the problem you are reporting has already been addressed and resolved. If you come across a closed issue that pertains to your problem, please leave a comment on that issue instead of creating a new one.
10-
- If the default Linux distribution is not adhered to, script support will be discontinued.
11-
- When encountering the error message `[ERROR] in line 23: exit code *: while executing command "$@" > /dev/null 2>&1`, make sure to run the script in verbose mode to accurately determine the underlying issue.
12-
- For suggestions, questions, or feature/script requests, please use the [Discussions section.](https://github.com/community-scripts/ProxmoxVE/discussions)
8+
# 🐞 **Script Issue Report**
9+
Thank you for taking the time to report an issue! Please provide as much detail as possible to help us address the problem efficiently.
10+
11+
## ⚠️ **IMPORTANT**
12+
- 🔍 **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.
13+
Alternatively, check the **[Discussions](https://github.com/community-scripts/ProxmoxVE/discussions)** under the *"Announcement"* or *"Guide"* categories for relevant information.
14+
- 🛠️ **Supported environments only:** Ensure you are using a default Linux distribution. Custom setups may not be supported.
15+
- 🔎 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.
16+
- 💡 For general questions, feature requests, or suggestions, use the [Discussions section](https://github.com/community-scripts/ProxmoxVE/discussions).
1317
1418
- type: input
1519
id: guidelines
1620
attributes:
17-
label: Please verify that you have read and understood the guidelines.
21+
label: ✅ Have you read and understood the above guidelines?
1822
placeholder: "yes"
1923
validations:
2024
required: true
2125

26+
- type: input
27+
id: script_name
28+
attributes:
29+
label: 📜 What is the name of the script you are using?
30+
placeholder: "e.g., NextcloudPi, Zigbee2MQTT"
31+
validations:
32+
required: true
33+
34+
- type: input
35+
id: script_command
36+
attributes:
37+
label: 📂 What was the exact command used to execute the script?
38+
placeholder: "e.g., bash -c \"$(wget -qLO - https://github.com/community-scripts/ProxmoxVE/raw/main/ct/zigbee2mqtt.sh)\" or \"update\""
39+
validations:
40+
required: true
41+
2242
- type: textarea
23-
id: bug
43+
id: issue_description
2444
attributes:
25-
label: A clear and concise description of the issue.
45+
label: 📝 Provide a clear and concise description of the issue.
2646
validations:
2747
required: true
28-
48+
2949
- type: checkboxes
3050
validations:
3151
required: true
3252
attributes:
33-
label: What settings are you currently utilizing?
53+
label: ⚙️ What settings are you using?
3454
options:
3555
- label: Default Settings
3656
- label: Advanced Settings
3757

3858
- type: markdown
3959
attributes:
40-
value: "If using Advanced Settings, please try Default Settings before creating an issue."
60+
value: "💡 **Tip:** If you are using Advanced Settings, please test with Default Settings before submitting an issue."
4161

4262
- type: dropdown
43-
id: distribution
63+
id: linux_distribution
4464
attributes:
45-
label: Which Linux distribution are you employing?
65+
label: 🖥️ Which Linux distribution are you using?
4666
options:
4767
-
4868
- Alpine
@@ -51,21 +71,30 @@ body:
5171
- Ubuntu 20.04
5272
- Ubuntu 22.04
5373
- Ubuntu 24.04
74+
- Ubuntu 24.10
5475
validations:
5576
required: true
5677

5778
- type: textarea
58-
id: screenshot
79+
id: steps_to_reproduce
5980
attributes:
60-
label: If relevant, including screenshots or a code block can be helpful in clarifying the issue.
61-
placeholder: "Code blocks begin and conclude by enclosing the code with three backticks (```) above and below it."
81+
label: 🔄 Steps to reproduce the issue.
82+
placeholder: "e.g., Step 1: ..., Step 2: ..."
6283
validations:
63-
required: false
84+
required: true
85+
86+
- type: textarea
87+
id: error_output
88+
attributes:
89+
label: ❌ Paste the full error output (if available).
90+
placeholder: "Include any relevant logs or error messages."
91+
validations:
92+
required: true
6493

6594
- type: textarea
66-
id: reproduce
95+
id: additional_context
6796
attributes:
68-
label: Please provide detailed steps to reproduce the issue.
69-
placeholder: "First do this, then this ..."
97+
label: 🖼️ Additional context (optional).
98+
placeholder: "Include screenshots, code blocks (use triple backticks ```), or any other relevant information."
7099
validations:
71100
required: false

.github/pull_request_template.md

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,39 @@
1-
> [!NOTE]
2-
> We are meticulous when it comes to merging code into the main branch, so please understand that we may reject pull requests that do not meet the project's standards. It's never personal. Also, game-related scripts have a lower chance of being merged.
1+
> **🛠️ Note:**
2+
> We are meticulous about merging code into the main branch, so please understand that pull requests not meeting the project's standards may be rejected. It's never personal!
3+
> 🎮 **Note for game-related scripts:** These have a lower likelihood of being merged.
34
4-
## Description
5+
---
56

7+
## ✍️ Description
68
Provide a summary of the changes made and/or reference the issue being addressed.
79

8-
Fixes # (issue)
10+
-
911

10-
## Type of change
11-
Please check the relevant option(s):
12+
- - -
1213

13-
- [ ] Bug fix (non-breaking change that resolves an issue)
14-
- [ ] New feature (non-breaking change that adds functionality)
15-
- [ ] Breaking change (a fix or feature that would cause existing functionality to change unexpectedly)
16-
- [ ] New script (a fully functional and thoroughly tested script or set of scripts.)
14+
- Related Issue: # (issue number, if applicable)
15+
- Related PR: # (if applicable)
16+
- Related Discussion: [Link](https://github.com/community-scripts/ProxmoxVE/discussions)
1717

18-
## Prerequisites
19-
The following efforts must be made for the PR to be considered. Please check when completed:
20-
- [ ] Self-review performed (I have reviewed my code, ensuring it follows established patterns and conventions)
21-
- [ ] Testing performed (I have tested my changes, ensuring everything works as expected)
22-
- [ ] Documentation updated (I have updated any relevant documentation)
18+
---
19+
20+
## 🛠️ Type of Change
21+
Please check the relevant options:
22+
- [ ] Bug fix (non-breaking change that resolves an issue)
23+
- [ ] New feature (non-breaking change that adds functionality)
24+
- [ ] Breaking change (fix or feature that would cause existing functionality to change unexpectedly)
25+
- [ ] New script (a fully functional and thoroughly tested script or set of scripts)
2326

24-
## Additional Information (optional)
25-
Provide any additional context or screenshots about the feature or fix here.
27+
---
28+
29+
## ✅ Prerequisites
30+
The following steps must be completed for the pull request to be considered:
31+
- [ ] Self-review performed (I have reviewed my code to ensure it follows established patterns and conventions.)
32+
- [ ] Testing performed (I have thoroughly tested my changes and verified expected functionality.)
33+
- [ ] Documentation updated (I have updated any relevant documentation)
2634

35+
---
2736

28-
## Related Pull Requests / Discussions
37+
## 📋 Additional Information (optional)
38+
Provide any extra context or screenshots about the feature or fix here.
2939

30-
If there are other pull requests or discussions related to this change, please link them here:
31-
- Related PR #

0 commit comments

Comments
 (0)