1
0
mirror of synced 2025-12-23 21:07:12 -05:00
Files
docs/content/contributing/collaborating-on-github-docs/self-review-checklist.md
2024-07-16 16:29:57 +00:00

16 lines
1.0 KiB
Markdown

---
title: Self review checklist
intro: "Before you submit your documentation pull request for review, you should first review it yourself."
versions:
feature: 'contributing'
---
Before you submit your changes to the {% data variables.product.prodname_docs %} team for review, work through the list below to complete your self review.
* Changes meet the **content goals and user needs** in the content design plan, if one has been created.
* Content has been **confirmed for accuracy** by a subject matter expert (SME) in the technical area.
* Content follows **quality guidelines** in "[AUTOTITLE](/contributing/writing-for-github-docs/best-practices-for-github-docs)" and "[AUTOTITLE](/contributing/writing-for-github-docs/writing-content-to-be-translated)."
* Content is **free of errors** such as typos and adheres to the "[AUTOTITLE](/contributing/style-guide-and-content-model/style-guide)."
* The article **renders properly on staging** for each version of the article (Free Pro Team, GHEC, GHES).
* All **pull request checks** are passing.