Skip to content

Commit a5f6c12

Browse files
Update PULL_REQUEST_TEMPLATE.md
Signed-off-by: LUIZ HAMILTON ROBERTO DA SILVA <[email protected]>
1 parent 473480c commit a5f6c12

1 file changed

Lines changed: 42 additions & 52 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 42 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,42 @@
1-
<div>
2-
<h1>🚀 Pull Request Template</h1>
3-
4-
<h2>📝 Description</h2>
5-
<p>
6-
Please include a <strong>summary of the changes</strong> and the related issue. Explain the <strong>rationale behind the changes</strong>, focusing on the problem that the pull request is solving.
7-
</p>
8-
9-
<h2>🔗 Related Issue</h2>
10-
<p>
11-
Link to the issue that this pull request addresses (e.g., <code>Fixes #123</code>).
12-
</p>
13-
14-
<h2>🛠️ Type of Change</h2>
15-
<p>Please select the type of change by marking the relevant checkboxes:</p>
16-
<ul>
17-
<li>🐞 <strong>Bug fix</strong> (non-breaking change which fixes an issue)</li>
18-
<li>✨ <strong>New feature</strong> (non-breaking change which adds functionality)</li>
19-
<li>🔥 <strong>Breaking change</strong> (fix or feature that would cause existing functionality to not work as expected)</li>
20-
<li>📚 <strong>Documentation update</strong> (if none of the above apply)</li>
21-
</ul>
22-
23-
<h2>🧪 How Has This Been Tested?</h2>
24-
<p>
25-
Please describe the <strong>tests that you ran</strong> to verify your changes. Provide instructions so that others can reproduce them:
26-
</p>
27-
<ul>
28-
<li>✅ <strong>Test A:</strong> [Description of Test A]</li>
29-
<li>✅ <strong>Test B:</strong> [Description of Test B]</li>
30-
</ul>
31-
<p>
32-
Include details of your <strong>test environment</strong>, including the OS version, PowerShell version, and any other relevant software.
33-
</p>
34-
35-
<h2>☑️ Checklist</h2>
36-
<p>Ensure that your pull request meets the following criteria:</p>
37-
<ul>
38-
<li>🧼 <strong>Code follows the style guidelines</strong> of this project</li>
39-
<li>🔍 <strong>Self-review</strong> of my own code</li>
40-
<li>💬 <strong>Commented my code</strong>, particularly in hard-to-understand areas</li>
41-
<li>📄 <strong>Corresponding changes</strong> have been made to the documentation</li>
42-
<li>🚫 <strong>No new warnings</strong> have been introduced</li>
43-
<li>✅ <strong>Added tests</strong> that prove my fix is effective or that my feature works</li>
44-
<li>🧪 <strong>New and existing unit tests</strong> pass locally with my changes</li>
45-
<li>🔗 <strong>Any dependent changes</strong> have been merged and published in downstream modules</li>
46-
</ul>
47-
48-
<h2>🗒️ Additional Notes</h2>
49-
<p>
50-
Add any <strong>additional information</strong> that might be useful when reviewing your pull request.
51-
</p>
52-
</div>
1+
# 🚀 Pull Request
2+
3+
## 📝 Description
4+
Provide a **summary of the changes** and the **rationale** (what problem this PR solves).
5+
6+
## 🔗 Related Issue
7+
Link the issue this PR addresses (example: `Fixes #123`)
8+
9+
- Fixes #
10+
11+
## 🛠️ Type of Change
12+
Select the type of change:
13+
14+
- [ ] 🐞 Bug fix (non-breaking change that fixes an issue)
15+
- [ ] ✨ New feature (non-breaking change that adds functionality)
16+
- [ ] 🔥 Breaking change (fix or feature that changes existing behavior)
17+
- [ ] 📚 Documentation update
18+
19+
## 🧪 How Has This Been Tested?
20+
Describe the tests you ran and how to reproduce them.
21+
22+
**Tests executed:**
23+
- ✅ Test A:
24+
- ✅ Test B:
25+
26+
**Test environment:**
27+
- OS:
28+
- PowerShell:
29+
- Other relevant details:
30+
31+
## ☑️ Checklist
32+
- [ ] 🧼 Code follows the style guidelines of this project
33+
- [ ] 🔍 Self-reviewed my own code
34+
- [ ] 💬 Added comments in hard-to-understand areas (when needed)
35+
- [ ] 📄 Updated documentation (if applicable)
36+
- [ ] 🚫 No new warnings introduced
37+
- [ ] ✅ Added tests that prove the fix/feature works (if applicable)
38+
- [ ] 🧪 New and existing tests pass locally (if applicable)
39+
- [ ] 🔗 Any dependent changes have been merged/published (if applicable)
40+
41+
## 🗒️ Additional Notes
42+
Add any extra context for reviewers (screenshots, logs, follow-ups, etc.).

0 commit comments

Comments
 (0)