|
| 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 | +--> |
0 commit comments