jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-21 10:57:10 -05:00
Code Issues Projects Releases Wiki Activity

Small updates to "Self-review checklist" (#51523)

Browse Source 
Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
This commit is contained in:
Annelisa Stephan
2024-07-16 09:29:57 -07:00
committed by GitHub
parent c3240a61ab
commit 1e94c07640
1 changed files with 7 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
content/contributing/collaborating-on-github-docs/self-review-checklist.md
View File

@@ -1,16 +1,15 @@
--- ---
title: Self review checklist title: Self review checklist
intro: "Before you submit your pull request for review, you should first review it yourself." intro: "Before you submit your documentation pull request for review, you should first review it yourself."
versions: versions:
feature: 'contributing' 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. 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.
* If there is a content design plan, confirm that your changes meet the user experience and goals outlined in the plan. * Changes meet the **content goals and user needs** in the content design plan, if one has been created.
* After opening your pull request, view your changes on staging to confirm the article renders as expected and matches the source. This helps spot issues like typos, content that doesn't follow the style guide, or content that isn't rendering due to versioning problems. * Content has been **confirmed for accuracy** by a subject matter expert (SME) in the technical area.
* Review your changes for technical accuracy. * 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)."
* Review your entire pull request to ensure it follows our guidance on creating content that can be translated. For more information, see "[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)."
* Check your changes for grammar, spelling, and adherence to the style guide. For more information, see "[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).
* If you have added new versioning or made changes to existing versioning, confirm your changes render as expected while viewing each available version of the article. * All **pull request checks** are passing.
* If there are any failing checks in your pull request, troubleshoot them until they're all passing.