docs/.github/review-template.md

2.2 KiB

Author self-review

  • The changes in this PR meet the user experience and goals outlined in the content design plan.
  • The changes in this PR adhere to our style guide, content model, and "Writing content to be translated."
  • Compare this PR's source changes to the preview deployment and review for versioning issues, redirects, rendering problems, typos, and wonky screenshots.
  • All screenshots in this PR adhere to the guidance in "Creating screenshots."
  • All checks are passing.
  • For REST API content, verify that endpoints, parameters, and responses are correct and work as expected and provided curl samples below.

For more information, check out our review process.

Review request

Summary

Help reviewers understand this project and its context by writing a paragraph summarizing its goals and intended user experience and explaining how the PR meets those goals. [Content design plan](LINK HERE)

Docs Content review

Give Docs Content any extra context, highlight areas for them to consider in their review, and ask them questions you need answered to ship the PR.

Technical review

Ping in technical reviewers, asking them to review whether content is technically accurate and right for the audience. Highlight areas for them to consider in their review and ask them questions you need answered to ship the PR.

Content changes

[PR on staging](LINK HERE)

Give a high-level overview of the changes in your PR and how they support the overall goals of the PR. Share links to important articles or changes in source and on staging. If your PR is large or complex, use a table to highlight changes with high user impact.

Notes

Discuss test failures, versioning issues, or anything else reviewers should know to consider the overall user experience of the PR.