2.6 KiB
Reviewing content
Angular developers work best when they have access to accurate and complete documentation. Keeping existing content up-to-date is an essential part of ensuring that all developers have a great documentation experience.
This topic describes how you can help keep Angular content up-to-date by reviewing content.
Before you begin
You can review content even if you've never contributed to Angular before. However, you may find it helpful to have the Contributing to Angular guide available if you're filing your first pull request in the repository.
Reviewing content (@reviewed)
All of the task-based guides, tutorials, and conceptual topics that you find on Angular.io support a @reviewed tag. When present, this tag is followed by the date representing when a given topic was reviewed for accuracy and completeness. On the published topic, this reviewed information appears at the bottom of the topic; for example, Last reviewed on followed by the day of the week, month, day, and year.
This reviewed date indicates when someone last reviewed the topic to ensure that its contents were accurate.
You can review a topic using either the GitHub user interface or in an editor on your local machine. You can also review any topic that you like. Previous experience in the subject of the topic is helpful, but not required.
To review a topic:
-
Navigate to the topic that you want to review.
-
Locate the last reviewed date at the bottom of the topic and verify that the topic meets the review criteria.
If the topic does not have a last reviewed date, you are welcome to add it to the topic.
-
Read through the topic.
-
If the topic requires an update, either file an issue that describes the update required, or create a pull request with the update.
-
Update the
@reviewedtag, either through the GitHub user interface or through Angular's standard pull request process.
{@a review-criteria}
Review criteria
In general, topics should be reviewed either every six months, or around every major release.