|
1 | | -# PR Review Procedure |
| 1 | +# Content PR Review Procedure |
2 | 2 |
|
3 | 3 | ## Abstract |
4 | 4 | This document outlines the Maintainer procedure for reviewing and merging PRs to the [Space Station 14 repository](https://github.com/space-wizards/space-station-14) `master` branch (otherwise known as the Content repository). |
@@ -166,27 +166,3 @@ Next: |
166 | 166 | If the pull request gets kicked out of the merge queue due to failing tests, check if the test failure is related to the PR. If not, re-add the pull request to the merge queue. |
167 | 167 |
|
168 | 168 | If the test is a Heisentest (a bug causing a rare, sporadic test fail), it should be logged in the [Heisentest bug tracker](https://github.com/space-wizards/space-station-14/issues/41081). |
169 | | - |
170 | | -## Reviewing Docs Pull Requests |
171 | | -The Docs repo has a different review policy compared to the Content repository. |
172 | | -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. |
173 | | - |
174 | | -### Pushing to the Docs Repo |
175 | | -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. |
176 | | - |
177 | | -### PR Reviews |
178 | | -PRs that update instructional or reference documentation (including but not limited to setup guides, style guides, system documentation) require only a single approval before it can be merged. |
179 | | -Likewise, only a single maintainer needs to express concern to close it. |
180 | | - |
181 | | -Note that this does not apply to changes to internal procedure or other modifications that require voting or group deliberation according to relevant policy. |
182 | | - |
183 | | -#### Design Documents |
184 | | -Major PRs that introduce or change a design document should require at least two maintainer approvals. |
185 | | -If the addition is large enough, a maintainer can call a vote on the design document; however, this should be done only when the scope of the pull request warrants it. |
186 | | - |
187 | | -Major game features usually follow the below dynamic: |
188 | | -1. A contributor creates a preliminary design document demonstrating what they would like to add, offering a high-level overview of how it fits into the game. |
189 | | -2. Maintainers discuss the document in an informal discussion. If most agree, the document is marked with `S: Doc Approved`, and the contributor can start work on the actual feature. As the feature is developed, the document is updated if necessary. |
190 | | -3. Once the content-side implementation is ready to be merged, both the design document and the content pull request are merged in tandem. |
191 | | - |
192 | | -The intention behind this is to ensure that contributors do not waste time implementing a feature that may not fit well into Upstream's intended gameplay. |
0 commit comments