-
Notifications
You must be signed in to change notification settings - Fork 267
Codeowners Policy #574
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Simyon264
merged 12 commits into
space-wizards:master
from
ArtisticRoomba:policy/codeowners
Jan 7, 2026
Merged
Codeowners Policy #574
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
8e387c4
Add workgroup policy page to SUMMARY.md
ArtisticRoomba 8810d85
Fix links on maintainer-workgroup-policy.md
ArtisticRoomba e6e0c99
Merge branch 'upstream-master'
ArtisticRoomba 3777266
Merge branch 'master' of https://github.com/space-wizards/docs
ArtisticRoomba 2b8780a
Merge branch 'master' of https://github.com/space-wizards/docs
ArtisticRoomba c771355
Merge branch 'master' of https://github.com/space-wizards/docs
ArtisticRoomba 90b2243
Merge branch 'master' of https://github.com/space-wizards/docs
ArtisticRoomba 6cab3be
codeowners policy
ArtisticRoomba ebae537
add 3 day timeout
ArtisticRoomba b4406f6
fix link
ArtisticRoomba f87a7df
addr review
ArtisticRoomba c3cff37
addr reviews
ArtisticRoomba File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| # Codeowners Policy | ||
| This document outlines the Codeowners policy, a permission granted to Maintainers by Lead Maintainers. | ||
|
|
||
| This permission allows them to process and merge pull requests on their own accord, including pull requests authored by the codeowner. | ||
|
|
||
| ## Goals | ||
| The codeowners policy aims to achieve the following: | ||
| 1. **Increase velocity and turnaround time for pull requests that touch a system when no maintainer is available for review.** | ||
| 1. Many abandoned/derelict systems have been adopted by a maintainer who now knows the system extensively. Oftentimes, work on a system is blocked by pull requests that would normally require another maintainer to re-learn the system in order to give a proper review. This results in work being stalled for months, as learning the system is often a great effort that is not feasible to exert. | ||
|
|
||
| ## Policy | ||
|
|
||
| ### Supervision | ||
| Maintainers who perform codeowner actions are overseen by the Lead Maintainers. | ||
|
|
||
| They are to make sure that the aforementioned policy is followed. | ||
|
|
||
| ### Formation | ||
| Maintainers are granted codeowner permissions for their chosen system by a Lead Maintainer. | ||
| Lead Maintainers can also deny the permissions if they do not deem the maintainer to be fit for the system, or if the requested system is undefinable in scope. | ||
|
|
||
| A maintainer can request codeowner permissions in any format, but it should ideally be in a space where it is documented and the active maintainer team knows about it (ex. a maintainer meeting). | ||
|
|
||
| Maintainers should only be granted codeowner permissions if it has been persistently demonstrated that there is no other maintainer available to review the other maintainer's pull requests in a reasonable timeframe. | ||
|
|
||
| ### Revocation | ||
| Lead Maintainers may revoke codeowner permissions from a maintainer at any time. | ||
| Revocation is usually due to the following reasons: | ||
| - The maintainer has refused to implement tests or demonstrate performance improvements via benchmarks. | ||
| - The maintainer is merging large swaths of undocumented code. | ||
| - The maintainer exercises negligence in making sure that their code does not contain bugs. | ||
| - The maintainer is present for submitting and merging pull requests, but largely absent when bugs caused by them need fixing. | ||
|
|
||
| ### Scope | ||
| The system that the maintainer chooses to become a codeowner for must be definable in scope. | ||
| Maintainers cannot simply request to claim all `EntitySystem`s, rather the request must be for a specific group of systems or mechanic that the maintainer is familiar with. Examples include: | ||
| - Atmospherics | ||
| - Solutions | ||
| - Physics | ||
| - Explosions | ||
| - Pow3r | ||
ArtisticRoomba marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### Permissions and Requirements | ||
| Maintainers with codeowner permissions have greater power over their area, however they must furfill specific requirements before exercising it. | ||
| 1. **Codeowners can process pull requests targeting their scope by themselves.** | ||
| 1. No second review is required for merging. | ||
| 2. Codeowners can process their own pull requests (self-merging). | ||
| 3. The pull request must have tests that properly cover the changes. | ||
| 4. If the pull request targets performance improvements, the improvements must be demonstrated by a benchmark. | ||
| 5. The pull request must be open for at least 3 days before merging. | ||
|
|
||
| There is no restriction for regular maintainers processing pull requests that touch a scope claimed by a codeowner. | ||
| However, it is recommended that maintainers, when doing so, defer to the codeowner in question. | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.