Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Meowius self review checklist update #35170

Closed
wants to merge 2 commits into from
Closed

Meowius self review checklist update #35170

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
43d0a1e
Update self-review checklist to include best practices article and be…
meowius Jul 1, 2024
c125b0f
Fix linting error: asterisks > hyphens
meowius Jul 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions content/contributing/collaborating-on-github-docs/self-review-checklist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
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:
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.

* If there is a content design plan, confirm that your changes meet the user experience and goals outlined in the plan.
* 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.
* Review your changes for technical accuracy.
* 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)."
* 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)."
* 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.
* If there are any failing checks in your pull request, troubleshoot them until they're all passing.
* [ ] If there is a content design plan, your changes meet the user experience and goals outlined in the plan.
* [ ] Changes have been reviewed for accuracy by a subject matter expert (SME) in the technical area.
* [ ] The article renders as expected on staging and matches the source. Content is free of errors such as typos and rendering issues due to versioning problems.
* [ ] Content follows the 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)."
* [ ] All content has correct grammar and spelling, and adheres to the "[AUTOTITLE](/contributing/style-guide-and-content-model/style-guide)."
* [ ] If you have added new versioning or made changes to existing versioning, your changes render as expected on all versions of the article.
* [ ] All checks on your pull request are passing. Any failing checks are addressed and are now passing.
Loading