From a8dc7c82e1f2b7091204a46e9bab89a8ac2f3893 Mon Sep 17 00:00:00 2001 From: Rem Date: Sun, 8 Mar 2026 01:24:37 -0600 Subject: [PATCH 1/3] Add text for leaving comments or requesting changes and other minor edits. --- .../maintainer/doc-review-procedure.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/src/en/wizden-staff/maintainer/doc-review-procedure.md b/src/en/wizden-staff/maintainer/doc-review-procedure.md index f6793491cf..ce90634f40 100644 --- a/src/en/wizden-staff/maintainer/doc-review-procedure.md +++ b/src/en/wizden-staff/maintainer/doc-review-procedure.md @@ -4,13 +4,28 @@ The Docs repo has a different review policy compared to the Content repository. Since the Docs repo can be pushed to directly by maintainers, is mostly text-based, can be easily reverted/changed, and does not affect forks, most docs pull requests can be handled by a single maintainer. ### Pushing to the Docs Repo -Maintainers have direct push access to the Docs repo and are encouraged to use it to update any outdated information, whether it's technical documentation, amending a design document, or just fixing grammar. +Maintainers have direct push access to the docs repository and are encouraged to use it to update any outdated information, whether it's technical documentation, amending a design document, or just fixing grammar. ### PR Reviews PRs that update instructional or reference documentation (including, but not limited to, setup guides, style guides, and system documentation) require only a single approval before they can be merged. Likewise, only a single maintainer needs to express concern to close it. -Note that this does not apply to changes to internal procedure or other modifications that require voting or group deliberation according to relevant policy. +Note that this does not apply to changes to internal procedures or other modifications that require voting or group deliberation under relevant policy. + +When leaving comments or requesting changes: +- Use **constructive** language and avoid being overly negative. +- Try not to be _overly_ vulgar or swear in a derogatory way. +- Avoid comments that personally criticize the author. + - It's okay to critique ideas and decisions, but you shouldn't insult their character. +- For people who may not be familiar with a part in their PR, try to be more thorough in your explanations. + - Explain your review to teach people unfamiliar with the subject. +- When possible, direct people to either the [developer wiki](https://docs.spacestation14.com/index.html), `#docs` discord channel, or an alternate source for information. +- Make an effort to be available after reviewing a PR. + - You don't need to be constantly online, but if the author has questions, they should be able to get a response in a reasonable amount of time. +- Be formal when closing PRs. + - Discourage others from engaging in rude behavior and try not to upset the PR author. People can often be emotional after their PR is closed. +- For relatively minor changes, opt to simply [complete them yourself](https://cli.github.com/manual/gh_pr_checkout) and push to the PR. +- When requesting changes to a PR, keep them within the scope of the PR. #### Design Documents Major PRs that introduce or change a design document should require at least two maintainer approvals. Unlike other doc PRs, design docs can only be approved by those with content maintainer permissions. From 947a77c54253efd53d61e9f06b907042ff504e9e Mon Sep 17 00:00:00 2001 From: Rem Date: Sun, 8 Mar 2026 01:41:49 -0600 Subject: [PATCH 2/3] Docutainers and repositories. --- src/en/wizden-staff/maintainer/doc-review-procedure.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/en/wizden-staff/maintainer/doc-review-procedure.md b/src/en/wizden-staff/maintainer/doc-review-procedure.md index ce90634f40..e62fe0f518 100644 --- a/src/en/wizden-staff/maintainer/doc-review-procedure.md +++ b/src/en/wizden-staff/maintainer/doc-review-procedure.md @@ -3,8 +3,10 @@ The Docs repo has a different review policy compared to the Content repository. Since the Docs repo can be pushed to directly by maintainers, is mostly text-based, can be easily reverted/changed, and does not affect forks, most docs pull requests can be handled by a single maintainer. -### Pushing to the Docs Repo -Maintainers have direct push access to the docs repository and are encouraged to use it to update any outdated information, whether it's technical documentation, amending a design document, or just fixing grammar. +### Pushing to the Docs and Content Repositories +Maintainers and docutainers have direct push access to the docs repository and are encouraged to use it to update any outdated information, whether it's technical documentation, amending a design document, or just fixing grammar. + +Docutainers can also review and merge guidebook PRs on the content repository, but should not abuse this to merge non-guidebook-related pull requests. ### PR Reviews PRs that update instructional or reference documentation (including, but not limited to, setup guides, style guides, and system documentation) require only a single approval before they can be merged. From 49b446258b0c1555e37fb56930ac193e57f2ac5d Mon Sep 17 00:00:00 2001 From: Rem Date: Sat, 14 Mar 2026 14:33:25 -0500 Subject: [PATCH 3/3] Clarification and minor fix. The docutainer policy mentions that docutainers can merge guidebook pull requests, which implies they also have maintainer permissions to the content repository. For the UI lead section, it should not be "which." --- src/en/wizden-staff/maintainer.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/en/wizden-staff/maintainer.md b/src/en/wizden-staff/maintainer.md index 90527d1cfd..4c586da3e2 100644 --- a/src/en/wizden-staff/maintainer.md +++ b/src/en/wizden-staff/maintainer.md @@ -12,7 +12,7 @@ An SS14 maintainer maintains the content side of Space Station 14. This includes ### Documaintainer -A documaintainer is an SS14 maintainer who only has maintainer powers for the docs repository. Within the docs repository, they have the same power and authority as an SS14 maintainer. +A documaintainer is an SS14 maintainer who only has maintainer powers for the docs and content repositories. Within the docs repository, they have the same power and authority as an SS14 maintainer. ### Head Mapper @@ -24,7 +24,7 @@ An art lead is an SS14 maintainer who has exclusive power over content PRs with ### UI Lead -A UI lead is an SS14 maintainer who has exclusive power over content PRs with UI changes and additions. These maintainers are expected to ensure the game retains usable, aesthetically pleasing UIs which fit the game's art style. +A UI lead is an SS14 maintainer who has exclusive power over content PRs with UI changes and additions. These maintainers are expected to ensure the game retains usable, aesthetically pleasing UIs that fit the game's art style. ### Robust Toolbox Maintainer