-
Notifications
You must be signed in to change notification settings - Fork 149
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Game-Area documentation overhaul, Work Groups and Maintainer/Review P…
…olicy (#199) The biggest change here is separating game (SS14) documentation into Game Areas to better categorize mechanics/docs and make it easier to find things. Game Areas are separated into Global and Department areas: - A Global Area is a part of the game that does not fit under a single department or is specific to the individual player's experience. These may also be high-level concepts related to the game. (For example: UI, Art, Mapping, Species, etc.) - A Department Area is a part of the game that fits the design/theme of a specific in-game department. (For Example: Security, Atmospherics, Command, etc.) This PR also implements workgroups as a concept (Code-Owners but for Game Design). A workgroup is an opt-in/opt-out role that is responsible for maintaining the documentation, design, and PR Guidelines of a Game Area. Maintainers can be a part of multiple workgroups or none if they so choose. Additionally, this PR will define policy for PR reviews, specifically going over the review process and what is required to approve/merge a PR. Along with a list of guidelines for contributors to look through to help speed up the review process. This also includes a Maintainer policy document that outlines the powers/expectations that the maintainer role entails, how maintainers are chosen, and what contributors should do if they want to become a maintainer someday.
- Loading branch information
Showing
68 changed files
with
366 additions
and
66 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains 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 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 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,3 @@ | ||
# Maintainer | ||
|
||
This section contains information on Maintaier and PR-Review Policies, **as it pertains to Wizards Den servers, hosted by Space Wizards.** These policies do not apply to other servers, and may be waived in exceptional circumstances. |
This file contains 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,5 @@ | ||
# Wizards Den Maintainer Policy | ||
|
||
```admonish warning "Work in Progress" | ||
This page is a work in progress! Maintainer policy will be posted when they are ready. | ||
``` |
This file contains 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,5 @@ | ||
# Wizards Den Review Policy | ||
|
||
```admonish warning "Work in Progress" | ||
This page is a work in progress! Review policy will be posted when they are ready. | ||
``` |
This file contains 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 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 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,57 @@ | ||
Work Groups | ||
===================== | ||
Work-groups are effectively the design equivalent to Code-Owners. Each work group is made up from maintainers that volunteer to upkeep the documentation and guidelines related to that area of the game. If you have a question about something related to one of the department/game areas feel free to message a member of its work group to get an authoritative answer. | ||
|
||
Each work group is responsible for maintaining corresponding design and pr guidelines documents in the docs repo that outlines the current and intended design for that game area, along with what is acceptible design/quality for a PR in that game area. Maintainers that are not part of any work groups are generalists, and while they might not be fully up to date with the design of a game-area they can still help answer questions. | ||
|
||
|
||
## Maintainer work groups: | ||
This list is updated less than discord/github, for a more accurate list look at the github work-group teams or discord roles. | ||
|
||
### Game-Wide | ||
- [Accessibility:](../space-station-14/areas/core/accessibility.md)\ | ||
Bhijn & Myr(deathride58), AJCM | ||
- [Admin Tooling:](../space-station-14/areas/core/admin-tools.md)\ | ||
Jezithyr, Chief-Engineer, Vasilis, Julian, Bhijn & Myr(deathride58) | ||
- [Art:](../space-station-14/areas/core/art.md)\ | ||
EmoGarbage, Flareguy | ||
- [Character/Species:](../space-station-14/areas/core/characters-species.md)\ | ||
Jezithyr, Lank, Vasilis, KeronSHB, Bhijn & Myr(deathride58), AJCM | ||
- [Combat:](../space-station-14/areas/core/combat.md)\ | ||
Jezithyr, EmoGarbage, AJCM, KeronSHB, Bhijn & Myr(deathride58) | ||
- [Player Interaction:](../space-station-14/areas/core/player-interaction.md)\ | ||
|
||
- [Mapping:](../space-station-14/areas/core/mapping.md)\ | ||
Emmise | ||
- [Roleplay/Lore:](../space-station-14/areas/core/roleplay-lore.md)\ | ||
Lank, KeronSHB, Vasilis | ||
- [Round Flow:](../space-station-14/areas/core/round-flow.md)\ | ||
Jezithyr, EmoGarbage, Tayrthan, KeronSHB, Bhijn & Myr(deathride58), AJCM | ||
- [User Interface:](../space-station-14/areas/core/user-interface.md)\ | ||
Jezithyr, EmoGarbage, AJCM, Julian, Bhijn & Myr(deathride58) | ||
|
||
### Departments | ||
- [Atmos:](../space-station-14/areas/departments/atmos.md)\ | ||
Jezithyr, KeronSHB, NotAFet(PartMedia) | ||
- [Cargo/Salvage:](../space-station-14/areas/departments/cargo-salvage.md)\ | ||
|
||
- [Command:](../space-station-14/areas/departments/command.md)\ | ||
KeronSHB, EmoGarbage, Vasilis | ||
- [Engineering:](../space-station-14/areas/departments/engineering.md)\ | ||
Jezithyr, Julian, AJCM, KeronSHB | ||
- [Medical:](../space-station-14/areas/departments/medical.md)\ | ||
Jezithyr, Vasilis, AJCM, | ||
- [Science:](../space-station-14/areas/departments/science.md)\ | ||
Jezithyr, EmoGarbage, AJCM, Tayrtahn | ||
- [Security:](../space-station-14/areas/departments/security.md)\ | ||
Lank(LankLTE), KeronSHB | ||
- [Service:](../space-station-14/areas/departments/service.md)\ | ||
AJCM, Tayrtahn, NotAFet(PartMedia) | ||
|
||
## For maintainers: | ||
|
||
Work-groups are non exclusive, you can be in as many or as few as you want, however you should expect to be able to answer questions and be involved in the design of the area's that you have selected. | ||
|
||
If you are not in a pr's associated work-group you can still review the PR, however you should make sure to read the relevant design documentation and PR guidelines before doing a review. Ideally, you should leave associated PRs to be reviewed by their work-group members, but it's fine to merge something as long as it fits the design and meets the guidelines. | ||
|
||
If you plan on being involved with a workgroup for a long time, please add yourself to the above list. Likewise, if you are on the list and leave the workgroup with no intention of returning to it, you should remove yourself from the list. |
This file contains 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 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,5 @@ | ||
# Accessibility | ||
|
||
```admonish warning "Attention: Placeholder!" | ||
This section is a placeholder, pending a design-doc being created by the related work-group | ||
``` |
5 changes: 5 additions & 0 deletions
5
src/en/space-station-14/areas/core/accessibility/guidelines.md
This file contains 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,5 @@ | ||
# PR Guildlines | ||
|
||
```admonish warning "Attention: Placeholder!" | ||
This section is a placeholder, pending a design-doc being created by the related work-group | ||
``` |
This file contains 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,5 @@ | ||
# Admin Tooling | ||
|
||
```admonish warning "Attention: Placeholder!" | ||
This section is a placeholder, pending a design-doc being created by the related work-group | ||
``` |
This file contains 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,5 @@ | ||
# PR Guildlines | ||
|
||
```admonish warning "Attention: Placeholder!" | ||
This section is a placeholder, pending a design-doc being created by the related work-group | ||
``` |
This file contains 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,5 @@ | ||
# Art | ||
|
||
```admonish warning "Attention: Placeholder!" | ||
This section is a placeholder, pending a design-doc being created by the related work-group | ||
``` |
File renamed without changes.
This file contains 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,5 @@ | ||
# PR Guildlines | ||
|
||
```admonish warning "Attention: Placeholder!" | ||
This section is a placeholder, pending a design-doc being created by the related work-group | ||
``` |
5 changes: 5 additions & 0 deletions
5
src/en/space-station-14/areas/core/character-species/guidelines.md
This file contains 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,5 @@ | ||
# PR Guildlines | ||
|
||
```admonish warning "Attention: Placeholder!" | ||
This section is a placeholder, pending a design-doc being created by the related work-group | ||
``` |
This file contains 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,5 @@ | ||
# Character/Species | ||
|
||
```admonish warning "Attention: Placeholder!" | ||
This section is a placeholder, pending a design-doc being created by the related work-group | ||
``` |
This file contains 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,5 @@ | ||
# Combat | ||
|
||
```admonish warning "Attention: Placeholder!" | ||
This section is a placeholder, pending a design-doc being created by the related work-group | ||
``` |
File renamed without changes.
This file contains 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,5 @@ | ||
# PR Guildlines | ||
|
||
```admonish warning "Attention: Placeholder!" | ||
This section is a placeholder, pending a design-doc being created by the related work-group | ||
``` |
This file contains 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,5 @@ | ||
# Mapping | ||
|
||
```admonish warning "Attention: Placeholder!" | ||
This section is a placeholder, pending a design-doc being created by the related work-group | ||
``` |
This file contains 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
35 changes: 32 additions & 3 deletions
35
...e-station-14/mapping/mapping-checklist.md → ...ation-14/areas/core/mapping/guidelines.md
This file contains 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.