|
| 1 | +# Pull Request Review Instructions |
| 2 | + |
| 3 | +1. **Check Formatting** |
| 4 | + - Ensure markdown headings are structured logically (H1 → H2 → H3). |
| 5 | + - Verify lists, tables, and code blocks render correctly. |
| 6 | + - Confirm links are valid and use relative paths when appropriate. |
| 7 | + |
| 8 | +2. **Validate Content** |
| 9 | + - Confirm technical accuracy (APIs, parameters, commands, screenshots). |
| 10 | + - Ensure examples are correct, build/run, and follow best practices. |
| 11 | + - Remove outdated references or deprecated features. |
| 12 | + |
| 13 | +3. **Style and Clarity** |
| 14 | + - Follow Microsoft Writing Style Guide (clarity, simplicity, consistency). |
| 15 | + - Use inclusive, neutral language. |
| 16 | + - Fix spelling, grammar, and punctuation issues. |
| 17 | + |
| 18 | +4. **Metadata and Structure** |
| 19 | + - Verify front matter (title, description, author, ms.service, ms.topic). |
| 20 | + - Ensure TOC placement and navigation are correct. |
| 21 | + - Confirm file naming and folder structure follow repo conventions. |
| 22 | + |
| 23 | +5. **Compliance and Security** |
| 24 | + - Remove secrets, keys, usernames, or confidential data. |
| 25 | + - Avoid third‑party copyrighted content without proper permission. |
| 26 | + - Check that code and text samples respect licensing requirements. |
| 27 | + |
| 28 | +6. **Testing and Validation** |
| 29 | + - Run any documented commands in a safe/test environment when possible. |
| 30 | + - Validate code snippets compile or run as described. |
| 31 | + - For UI steps, confirm that labels and flows match the current portal/CLI. |
| 32 | + |
| 33 | +7. **Review Outcome** |
| 34 | + - **Approve** when the change is technically correct, clear, and compliant. |
| 35 | + - **Request changes** with specific, actionable comments. |
| 36 | + - **Comment only** for non‑blocking suggestions or questions. |
0 commit comments