Skip to content

Commit 8408ca7

Browse files
pedrominatelpedrominatel
authored
Merge pull request #6 from f-hollow/create-pr-template-review
Create pr template review
2 parents 7560d8b + d92d31d commit 8408ca7

File tree

3 files changed

+170
-40
lines changed

3 files changed

+170
-40
lines changed

‎.github/pull_request_template.md‎

Lines changed: 57 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,83 @@
11

22
<!--
33
⚠️ PRE-SUBMISSION REMINDERS
4-
1. Read the project style guidelines (CONTRIBUTION.md).
4+
1. Read the project style guidelines (CONTRIBUTING.md).
55
2. For Work In Progress, please use the Draft PR feature.
66
3. Ensure you have tested locally with Hugo.
77
-->
88

99
## 📝 Description
10+
1011
<!--
1112
- Summary of the article or changes being introduced.
1213
- Context: Why is this change necessary? (e.g., New tutorial, fixing a typo, updating SDK version).
1314
-->
1415

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.
16+
17+
18+
## Publish date
19+
20+
Expected publish date: `YYYY-MM-DD`
21+
22+
<!--
23+
Please note the expected review time:
24+
- Announcements: within 1 week
25+
- Simple articles: 1-2 weeks
26+
- Tutorial or workshops: 3-4 weeks
3427
-->
3528

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.
29+
## Review process
30+
31+
- [ ] Initiate **technical review**
32+
- [ ] This item is N/A
33+
- Add subject matter experts (your team members, experts in the field)
34+
- [ ] Once tech review mostly done, initiate **editorial review**
35+
- Add technical editors (`@f-hollow`, `@FBEZ`, and/or `@pedrominatel`)
36+
37+
## Checks
38+
39+
- [ ] Article folder and file names:
40+
- Folder path is `content/blog/YYYY/MM/my-new-article` (articles only)
41+
- Folder and file names have no underscores, spaces, or uppercase letters (~~My new_article~~)
42+
- [ ] New article's YAML frontmatter:
43+
- Title updated
44+
- Date matches the format `date: 20YY-MM-DD`
45+
- Summary updated
46+
- Authors added (see [Add youself as an author](https://developer.espressif.com/pages/contribution-guide/writing-content/#add-youself-as-an-author))
47+
- Tags added
48+
- [ ] Updated article's YAML frontmatter:<br>
49+
- [ ] This item is N/A
50+
- If article folder is moved or renamed, the field `aliases:` with a new URL slug is added
51+
- Date of update is added `lastmode: 20YY-MM-DD`
52+
- [ ] Article media files:
53+
- All images are in .WebP format (see [Use WebP for raster images](https://developer.espressif.com/pages/contribution-guide/writing-content/#use-webp-for-raster-images))
54+
- Images are compressed within 100-300 KB, with a hard limit of ≤ 500 kB
55+
- Where possible, Hugo shortcodes are used instead of raw HTML for content types unsupported by markdown (see [Use additional content types](https://developer.espressif.com/pages/contribution-guide/writing-content/#use-additional-content-types))
56+
- [ ] Links in articles
57+
- Make sure all links are valid
58+
- No links to Google docs present
59+
- Use a specific ESP-IDF version in links (avoid `stable`, hard no for `latest`)
60+
- [ ] Git history
61+
- Commits are clean and squashed to the minimum necessary
62+
- Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format
63+
- Your feature branch is rebased on `main`
4164

4265
## 🔗 Related
66+
4367
<!--
4468
- Fixes #ISSUENUMBER
45-
- Links to related documentation, Jira tickets, or Chat discussions.
69+
- Related #PRNUMBER
70+
- Links to related documentation
4671
-->
4772

73+
74+
4875
## 🧪 Testing (Hugo)
76+
4977
<!--
50-
- Describe how you verified the content looks correct.
51-
-->
78+
Describe how you tested or verified your contribution. For example, you can say:
79+
5280
- [ ] I have run `hugo server` locally and verified there are no build errors.
5381
- [ ] I have checked the rendered output on Desktop and Mobile view.
5482
- [ ] 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.
83+
-->

‎.gitlab/merge_request_templates/merge_request_template.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
2+
<!--
3+
⚠️ PRE-SUBMISSION REMINDERS
4+
1. Read the project style guidelines (CONTRIBUTING.md).
5+
2. For Work In Progress, please prepend `Draft: ` to your MR title.
6+
3. Ensure you have tested locally with Hugo.
7+
-->
8+
9+
## 📝 Description
10+
11+
<!--
12+
- Summary of the article or changes being introduced.
13+
- Context: Why is this change necessary? (e.g., New tutorial, fixing a typo, updating SDK version).
14+
-->
15+
16+
17+
18+
## Publish date
19+
20+
Expected publish date: `YYYY-MM-DD`
21+
22+
<!--
23+
Please note the expected review time:
24+
- Announcements: within 1 week
25+
- Simple articles: 1-2 weeks
26+
- Tutorial or workshops: 3-4 weeks
27+
-->
28+
29+
## Review process
30+
31+
- [ ] Initiate **technical review**
32+
- [ ] This item is N/A
33+
- Add subject matter experts (your team members, experts in the field)
34+
- [ ] Once tech review mostly done, initiate **editorial review**
35+
- Add technical editors (`@kirill.chalov`, `@francesco.bez`, and/or `@pedro.minatel`)
36+
37+
## Checks
38+
39+
- [ ] Article folder and file names:
40+
- Folder path is `content/blog/YYYY/MM/my-new-article` (articles only)
41+
- Folder and file names have no underscores, spaces, or uppercase letters (~~My new_article~~)
42+
- [ ] New article's YAML frontmatter:
43+
- Title updated
44+
- Date matches the format `date: 20YY-MM-DD`
45+
- Summary updated
46+
- Authors added (see [Add youself as an author](https://developer.espressif.com/pages/contribution-guide/writing-content/#add-youself-as-an-author))
47+
- Tags added
48+
- [ ] Updated article's YAML frontmatter:<br>
49+
- [ ] This item is N/A
50+
- If article folder is moved or renamed, the field `aliases:` with a new URL slug is added
51+
- Date of update is added `lastmode: 20YY-MM-DD`
52+
- [ ] Article media files:
53+
- All images are in .WebP format (see [Use WebP for raster images](https://developer.espressif.com/pages/contribution-guide/writing-content/#use-webp-for-raster-images))
54+
- Images are compressed within 100-300 KB, with a hard limit of ≤ 500 kB
55+
- Where possible, Hugo shortcodes are used instead of raw HTML for content types unsupported by markdown (see [Use additional content types](https://developer.espressif.com/pages/contribution-guide/writing-content/#use-additional-content-types))
56+
- [ ] Links in articles
57+
- Make sure all links are valid
58+
- No links to Google docs present
59+
- Use a specific ESP-IDF version in links (avoid `stable`, hard no for `latest`)
60+
- [ ] Git history
61+
- Commits are clean and squashed to the minimum necessary
62+
- Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format
63+
- Your feature branch is rebased on `main`
64+
65+
## 🔗 Related
66+
67+
<!--
68+
- Fixes #ISSUENUMBER
69+
- Related !MRNUMBER
70+
- Links to related documentation
71+
-->
72+
73+
74+
75+
## 🧪 Testing (Hugo)
76+
77+
<!--
78+
Describe how you tested or verified your contribution. For example, you can say:
79+
80+
- [ ] I have run `hugo server` locally and verified there are no build errors.
81+
- [ ] I have checked the rendered output on Desktop and Mobile view.
82+
- [ ] I have verified that internal links and syntax highlighting work correctly.
83+
-->

‎CONTRIBUTING.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing to Espressif Developer Portal
2+
3+
Thank you for your interest in contributing. This portal aims to provide high-quality, accurate, and accessible technical content about Espressif products and the broader ecosystem.
4+
5+
We welcome contributions from both internal team members and the wider community, whether you are proposing new articles, improving existing content, or enhancing the underlying site infrastructure.
6+
7+
## How to Get Started
8+
9+
1. Review the Contribution Guide
10+
11+
For general contribution rules and editorial guidance, please refer to the [Contribution guide](https://developer.espressif.com/pages/contribution-guide/).
12+
13+
2. Discuss Your Idea (Optional)
14+
15+
Before starting work on your a contribution, feel free to open a discussion or an issue and propose:
16+
17+
- A new article or tutorial
18+
- Substantial updates to existing content
19+
- Changes to styling, templates, or site structure
20+
- Improvements to build or deployment workflows
21+
22+
This allows maintainers to provide feedback early, align on scope, and avoid duplicated effort.
23+
24+
## Code of Conduct
25+
26+
All contributors are expected to act respectfully and professionally. Feedback should be constructive, and discussions should remain focused on technical merit and clarity.
27+
28+
## License
29+
30+
By contributing, you agree that your submissions will be licensed under the same terms as this repository.

0 commit comments

Comments
 (0)