-
Notifications
You must be signed in to change notification settings - Fork 60.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update self-review checklist to include best practices article and be…
… in checklist format
- Loading branch information
Showing
1 changed file
with
8 additions
and
8 deletions.
There are no files selected for viewing
16 changes: 8 additions & 8 deletions
16
content/contributing/collaborating-on-github-docs/self-review-checklist.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |