Skip to content

Commit 7560d8b

Browse files
committed
Added the new template for PR's
1 parent 56796cc commit 7560d8b

File tree

1 file changed

+66
-0
lines changed

1 file changed

+66
-0
lines changed

.github/pull_request_template.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
2+
<!--
3+
⚠️ PRE-SUBMISSION REMINDERS
4+
1. Read the project style guidelines (CONTRIBUTION.md).
5+
2. For Work In Progress, please use the Draft PR feature.
6+
3. Ensure you have tested locally with Hugo.
7+
-->
8+
9+
## 📝 Description
10+
<!--
11+
- Summary of the article or changes being introduced.
12+
- Context: Why is this change necessary? (e.g., New tutorial, fixing a typo, updating SDK version).
13+
-->
14+
15+
<details>
16+
<summary>💡 <b>Tip: How to display screenshots in this PR description</b></summary>
17+
If you are adding screenshots to this description, please resize them for easier reading:
18+
19+
| Bad (Full Size) | Good (Resized) |
20+
| :--- | :--- |
21+
| `![alt](url)` | `<img src="url" width="500">` |
22+
</details>
23+
24+
## 🗓️ Publication Details (if it's content)
25+
| Check | Requirement |
26+
| :--- | :--- |
27+
| **Expected Publish Date** | `YYYY-MM-DD` |
28+
| **Frontmatter Updated?** | [ ] Yes |
29+
30+
<!--
31+
IMPORTANT:
32+
Ensure the date in this table matches the `date: 20xx-xx-xx` field inside your article's Markdown frontmatter.
33+
This controls when Hugo renders the post.
34+
-->
35+
36+
## 🖼️ Media & Assets
37+
**Strict Requirements:**
38+
- [ ] ALL images are in **.WEBP** format.
39+
- [ ] The **Featured Image** is **≤ 500kB**.
40+
- [ ] All other content images are compressed/optimized.
41+
42+
## 🔗 Related
43+
<!--
44+
- Fixes #ISSUENUMBER
45+
- Links to related documentation, Jira tickets, or Chat discussions.
46+
-->
47+
48+
## 🧪 Testing (Hugo)
49+
<!--
50+
- Describe how you verified the content looks correct.
51+
-->
52+
- [ ] I have run `hugo server` locally and verified there are no build errors.
53+
- [ ] I have checked the rendered output on Desktop and Mobile view.
54+
- [ ] I have verified that internal links and syntax highlighting work correctly.
55+
56+
---
57+
58+
## ✅ Final Checklist
59+
Before submitting, please ensure the following:
60+
61+
- [ ] 🤖 **CI Checks:** All GitHub Actions/Builds have passed.
62+
- [ ] 🚨 **No Breaking Changes:** The site builds without critical warnings.
63+
- [ ] 📅 **Date Consistency:** The 'Expected Publish Date' matches the article file content.
64+
- [ ] 🖼️ **Image Format:** All images are verified as `.webp`.
65+
- [ ] ⚖️ **Image Size:** Featured image is confirmed ≤ 500kB.
66+
- [ ] 🧹 **Git History:** Commits are clean and squashed to the minimum necessary.

0 commit comments

Comments
 (0)