From 09c3a99be80cf49179540bacfa533a5c544e9b4b Mon Sep 17 00:00:00 2001 From: Zach Parks Date: Thu, 27 Jul 2023 09:12:06 -0500 Subject: [PATCH] Docs: Create `CODEOWNERS` document for tracking world maintainers. (#1901) * Meta: Create code owners document for tracking and notifying owners of world changes. * Removing @dewiniaid as maintainer for Hollow Knight. 2023-07-11 - Finalization Date for Vote https://discord.com/channels/731205301247803413/1123286507390767267/1128482720218099812 @ThePhar - Vote to Remove (2023-06-27) @black-sliver - Vote to Remove (2023-06-27) @KonoTyran - Vote to Remove (2023-06-27) @Berserker66 - Vote to Remove (2023-07-09) Passed with majority to remove maintainer status. * Adding @BadMagic100 and @ThePhar as maintainers for Hollow Knight. @BadMagic100 to primarily handle client-side maintenance/updates. @ThePhar to primarily handle Archipelago-side maintenance/updates. https://discord.com/channels/731205301247803413/1131762415021858907 @ThePhar - Approved @BadMagic100 (2023-07-20) and @ThePhar (2023-07-24) as Maintainers @LegendaryLinux - Approved @BadMagic100 (2023-07-20) as Maintainer @Berserker66 - Approved @BadMagic100 (2023-07-26) and @ThePhar (2023-07-26) as Maintainers @black-sliver - Approved @BadMagic100 (2023-07-26) and @ThePhar (2023-07-26) as Maintainers @KonoTyran - Approved @BadMagic100 (2023-07-27) and @ThePhar (2023-07-27) as Maintainers Passed with a majority to set maintainer status for Hollow Knight. --- docs/CODEOWNERS | 166 +++++++++++++++++++++++++++++++++++++++ docs/world maintainer.md | 12 +-- 2 files changed, 172 insertions(+), 6 deletions(-) create mode 100644 docs/CODEOWNERS diff --git a/docs/CODEOWNERS b/docs/CODEOWNERS new file mode 100644 index 00000000..e92bfa42 --- /dev/null +++ b/docs/CODEOWNERS @@ -0,0 +1,166 @@ +# Archipelago World Code Owners / Maintainers Document +# +# This file is used to notate the current "owners" or "maintainers" of any currently merged world folder. For any pull +# requests that modify these worlds, a code owner must approve the PR in addition to a core maintainer. This is not to +# be used for files/folders outside the /worlds folder, those will always need sign off from a core maintainer. +# +# All usernames must be GitHub usernames (and are case sensitive). + +################### +## Active Worlds ## +################### + +# Adventure +/worlds/adventure/ @JusticePS + +# A Link to the Past +/worlds/alttp/ @Berserker66 + +# ArchipIDLE +/worlds/archipidle/ @LegendaryLinux + +# Sudoku (BK Sudoku) +/worlds/bk_sudoku/ @Jarno458 + +# Blasphemous +/worlds/blasphemous/ @TRPG0 + +# Bumper Stickers +/worlds/bumpstik/ @FelicitusNeko + +# ChecksFinder +/worlds/checksfinder/ @jonloveslegos + +# Clique +/worlds/clique/ @ThePhar + +# Dark Souls III +/worlds/dark_souls_3/ @Marechal-L + +# Donkey Kong Country 3 +/worlds/dkc3/ @PoryGone + +# DLCQuest +/worlds/dlcquest/ @axe-y @agilbert1412 + +# DOOM 1993 +/worlds/doom_1993/ @Daivuk + +# Factorio +/worlds/factorio/ @Berserker66 + +# Final Fantasy +/worlds/ff1/ @jtoyoda + +# Hollow Knight +/worlds/hk/ @BadMagic100 @ThePhar + +# Hylics 2 +/worlds/hylics2/ @TRPG0 + +# Kingdom Hearts 2 +/worlds/kh2/ @JaredWeakStrike + +# Links Awakening DX +/worlds/ladx/ @zig-for + +# Lufia II Ancient Cave +/worlds/lufia2ac/ @el-u +/worlds/lufia2ac/docs/ @wordfcuk @el-u + +# Meritous +/worlds/meritous/ @FelicitusNeko + +# The Messenger +/worlds/messenger/ @alwaysintreble + +# Minecraft +/worlds/minecraft/ @KonoTyran @espeon65536 + +# MegaMan Battle Network 3 +/worlds/mmbn3/ @digiholic + +# Muse Dash +/worlds/musedash/ @DeamonHunter + +# Noita +/worlds/noita/ @ScipioWright @heinermann + +# Ocarina of Time +/worlds/oot/ @espeon65536 + +# Overcooked! 2 +/worlds/overcooked2/ @toasterparty + +# Pokemon Red and Blue +/worlds/pokemon_rb/ @Alchav + +# Raft +/worlds/raft/ @SunnyBat + +# Rogue Legacy +/worlds/rogue_legacy/ @ThePhar + +# Risk of Rain 2 +/worlds/ror2/ @kindasneaki + +# Sonic Adventure 2 Battle +/worlds/sa2b/ @PoryGone @RaspberrySpace + +# Starcraft 2 Wings of Liberty +/worlds/sc2wol/ @Ziktofel + +# Super Metroid +/worlds/sm/ @lordlou + +# Super Mario 64 +/worlds/sm64ex/ @N00byKing + +# Super Mario World +/worlds/smw/ @PoryGone + +# SMZ3 +/worlds/smz3/ @lordlou + +# Secret of Evermore +/worlds/soe/ @black-sliver + +# Slay the Spire +/worlds/spire/ @KonoTyran + +# Stardew Valley +/worlds/stardew_valley/ @agilbert1412 + +# Subnautica +/worlds/subnautica/ @Berserker66 + +# Terraria +/worlds/terraria/ @Seldom-SE + +# Timespinner +/worlds/timespinner/ @Jarno458 + +# The Legend of Zelda (1) +/worlds/tloz/ @Rosalie-A @t3hf1gm3nt + +# Undertale +/worlds/undertale/ @jonloveslegos + +# VVVVVV +/worlds/v6/ @N00byKing + +# Wargroove +/worlds/wargroove/ @FlySniper + +# The Witness +/worlds/witness/ @NewSoupVi @blastron + +# Zillion +/worlds/zillion/ @beauxq + +################################## +## Disabled Unmaintained Worlds ## +################################## + +# Ori and the Blind Forest +# /worlds_disabled/oribf/ diff --git a/docs/world maintainer.md b/docs/world maintainer.md index 9cd7a378..15fa46a1 100644 --- a/docs/world maintainer.md +++ b/docs/world maintainer.md @@ -5,6 +5,7 @@ A world maintainer is a person responsible for a world or part of a world in Arc If a world author does not want to take on the responsibilities of a world maintainer, they can release their world as an unofficial [APWorld](/docs/apworld%20specification.md) or maintain their own fork instead. +All current world maintainers are listed in the [CODEOWNERS](/docs/CODEOWNERS) document. ## Responsibilities @@ -18,15 +19,15 @@ Unless these are shared between multiple people, we expect the following from ea pull requests. Core maintainers may also ping you if a pull request concerns your world. * Test (or have tested) the world on the main branch from time to time, especially during RC (release candidate) phases of development. -* Let us know of long unavailabilities. - +* Let us know of long periods of unavailability. ## Becoming a World Maintainer ### Adding a World When we merge your world into the core Archipelago repository, you automatically become world maintainer unless you -nominate someone else (i.e. there are multiple devs). +nominate someone else (i.e. there are multiple devs). You can define who is allowed to approve changes to your world +in the [CODEOWNERS](/docs/CODEOWNERS) document. ### Getting Voted @@ -36,12 +37,12 @@ For a vote to pass, the majority of participating core maintainers must vote in The time limit is 1 week, but can end early if the majority is reached earlier. Voting shall be conducted on Discord in #archipelago-dev. - ## Dropping out ### Resigning -A world maintainer can resign. If no new maintainer steps up and gets voted, the world becomes unmaintained. +A world maintainer can resign and have their username removed from the [CODEOWNERS](/docs/CODEOWNERS) document. If no +new maintainer takes over management of the world, the world becomes unmaintained. ### Getting Voted out @@ -53,7 +54,6 @@ made their case or was pinged and has been unreachable for more than 2 weeks alr Voting shall be conducted on Discord in #archipelago-dev. Commits that are a direct result of the voting shall include date, voting members and final result in the commit message. - ## Handling of Unmaintained Worlds As long as worlds are known to work for the most part, they can stay included. Once a world becomes broken it shall be