Self review checklist

Before you submit your documentation pull request for review, you should first review it yourself.

Before you submit your changes to the GitHub 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 "Best practices for GitHub Docs" and "Writing content to be translated."
  • Content is free of errors such as typos and adheres to the "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.