Skip to content
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

Docs: add info about maintaining worlds #1838

Merged
merged 11 commits into from
Jun 22, 2023

Conversation

black-sliver
Copy link
Member

Adds responsibilities of world maintainers/authors to the docs and proposes some rules how to fairly vote in and out maintainers.

Who should we ping?

Copy link
Contributor

@Joethepic Joethepic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple of word choice changes that I think would make more sense for the reader to read.

docs/world maintainer.md Outdated Show resolved Hide resolved
docs/world maintainer.md Outdated Show resolved Hide resolved
@Berserker66 Berserker66 changed the title Docs: add info about mainting worlds Docs: add info about maintaining worlds May 26, 2023
@Jarno458
Copy link
Collaborator

Jarno458 commented May 26, 2023

Not sure staging is a proper term for unmaintained broken worlds i think deprecated is better, but otherwise i think this ok

@kindasneaki
Copy link
Collaborator

Something like this would’ve been nice for when I took over RoR2, since I ended up needing to recreate the client for people to use. It took awhile for most people to realize that happened. I feel like for the voting part it should probably happen in discord, so that it is more public for everyone to know what’s going on.

@black-sliver
Copy link
Member Author

Not sure staging is a proper term for unmaintained broken worlds, but otherwise i think this ok

I think staging is the proper name for it. Normally staging happens before it enters production, but in this case we move it "back into" staging. People can look at and use the worlds manually, but they are not part of the production build.

@Jarno458
Copy link
Collaborator

i feel deprecated might be a better name,
Actually might be even better to move them to different repo all together, so we don't have to keep maintaining them and fixing things in them to keep them compatible and not have their python test fail

I understand we want them to be easily visible for someone to pickup and breath new life into them. but it also should not slow down development on ap or other worlds as some old legacy that keeps hunting you or failing your pytests

@black-sliver
Copy link
Member Author

black-sliver commented May 29, 2023

if they are in a folder that is ignored, they don't impact development. doing git mv is free, moving to a separate repo is not. also the worlds are not deprecated, they are broken or incomplete.

Copy link
Collaborator

@t3hf1gm3nt t3hf1gm3nt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'm kinda with Jarno that i dont think "staging" is the right word to use for the folder to move unmaintained worlds too, but I also can't think of a better word either, as i dont think "depreciated" is much better. Other than this little gripe, LGTM

@Jarno458
Copy link
Collaborator

With the agreement to name it disabled ill approve this PR

docs/world maintainer.md Outdated Show resolved Hide resolved
docs/world maintainer.md Outdated Show resolved Hide resolved
docs/world maintainer.md Outdated Show resolved Hide resolved
docs/world maintainer.md Outdated Show resolved Hide resolved
docs/world maintainer.md Outdated Show resolved Hide resolved
@ThePhar ThePhar added is: documentation Improvements or additions to documentation. meta: help wanted Additional review/assistance is requested for these issues or pull requests. labels May 31, 2023
@black-sliver black-sliver merged commit f36468f into ArchipelagoMW:main Jun 22, 2023
@black-sliver black-sliver deleted the doc-world-maintainers branch June 22, 2023 06:51
Witchybun pushed a commit to Witchybun/Archipelago that referenced this pull request Jun 26, 2023
* 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
FlySniper pushed a commit to FlySniper/Archipelago that referenced this pull request Nov 14, 2023
* 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
Jouramie pushed a commit to Jouramie/Archipelago that referenced this pull request Feb 28, 2024
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
is: documentation Improvements or additions to documentation. meta: help wanted Additional review/assistance is requested for these issues or pull requests.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants