forked from ArchipelagoMW/Archipelago
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: add info about maintaining worlds (ArchipelagoMW#1838)
* Docs: add info about mainting worlds * Docs: fix typos in world maintainer * Docs: commit suggestions into world maintainers Thanks Joethepic and Silvris * Docs: fix more typos in world maintainer * Docs: more typos * Docs: world maintainers link to core maintainers * Docs: world maintainers voting on discord * Docs: add 'world maintainer' link to 'adding games' * Docs: unmaintained worlds in 'disabled' * Docs: world maintainer update from review Thanks LegendaryLinux * Doc: rephrase world maintainer voting
- Loading branch information
1 parent
a939f50
commit f36468f
Showing
3 changed files
with
63 additions
and
0 deletions.
There are no files selected for viewing
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,60 @@ | ||
# World Maintainer | ||
|
||
A world maintainer is a person responsible for a world or part of a world in Archipelago. | ||
|
||
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. | ||
|
||
|
||
## Responsibilities | ||
|
||
Unless these are shared between multiple people, we expect the following from each world maintainer | ||
|
||
* Be on our Discord to get updates on problems with and suggestions for the world. | ||
* Decide if a feature (pull request) should be merged. | ||
* Review contents of such pull requests or organize peer reviews or post that you did not review the content. | ||
* Fix or point out issues when core changes break your code. | ||
* Use the watch function on GitHub, the #github-updates channel on Discord or check manually from time to time for new | ||
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. | ||
|
||
|
||
## 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). | ||
|
||
### Getting Voted | ||
|
||
When a world is unmaintained, the [core maintainers](https://github.com/orgs/ArchipelagoMW/people) | ||
can vote for a new maintainer if there is a candidate. | ||
For a vote to pass, the majority of participating core maintainers must vote in the affirmative. | ||
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. | ||
|
||
### Getting Voted out | ||
|
||
A world maintainer can be voted out by the [core maintainers](https://github.com/orgs/ArchipelagoMW/people), | ||
for example when they become unreachable. | ||
For a vote to pass, the majority of participating core maintainers must vote in the affirmative. | ||
The time limit is 2 weeks, but can end early if the majority is reached earlier AND the world maintainer was pinged and | ||
made their case or was pinged and has been unreachable for more than 2 weeks already. | ||
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 | ||
moved from `worlds/` to `worlds_disabled/`. |