PR workflow
Use this page to understand how new-guide and existing-guide PRs move through review, updates, and merge. Select the new-guide or existing-guide review path for your role.
SE1 and SE2 refer to Service Engineer levels 1 and 2. TW refers to Technical Writing. TW/SE reviewers may directly fix formatting, spelling, grammar, and wording that does not change technical meaning.
New guides
Section titled “New guides”Use the review path for the PR author’s role:
| PR author | Review path |
|---|---|
| SE1 | Author → SE2 review → TW review → Author merge |
| Authorized SE2 | Author adds SE2-reviewed → TW review → Author merge |
| Engineer / Other author | Author → Assign to FSE → TW review → SE2 review → FSE merge |
| FSE | Author → TW review → SE2 review → Author merge |
Edits to existing guides
Section titled “Edits to existing guides”The author remains responsible for the proposed change, review follow-through, and merge. Additional Engineering or FSE review can be requested when warranted.
| PR author | Review path |
|---|---|
| SE1 | Author → SE2 review → TW review → Author merge |
| Authorized SE2 | Author adds SE2-reviewed → TW review → Author merge |
| Engineer / Other author | Author → TW review → SE2 review → Author merge |
| FSE | Author → TW review → SE2 review → Author merge |
Review statuses
Section titled “Review statuses”- Not Started: The PR has been created but has not entered human review. A new-guide draft stays here while the author completes it.
- Waiting for TW Review: The PR is ready for Technical Writer review.
- Waiting for SE2 Review: The PR is ready for authorized SE2 technical review.
- Waiting for Author Updates: Requested changes or check failures need attention.
- Ready to Merge: Reviews, labels, and checks are complete and the PR is ready to merge. Auto-merge may be enabled for that individual PR.
Track the PR
Section titled “Track the PR”Track the PR’s status on the TSG Review Workflow board.