mozilla / sphinx-js

Autodoc-style extraction into Sphinx for your JS project
https://pypi.python.org/pypi/sphinx-js/
MIT License
278 stars 80 forks source link

transfer sphinx-js project #233

Open willkg opened 11 months ago

willkg commented 11 months ago

Issue #226 caused us to sit down and figure out the future of this project. @hoodmane is maintaining a fork for pyodide. We worked out that we're going to transfer this project to @hoodmane.

This covers the tasks to transfer:

hoodmane commented 11 months ago

remove CODE_OF_CONDUCT.md

Seems like a fine code of conduct but I guess it is very Mozilla branded. I guess we can copy our own version from here: https://github.com/pyodide/pyodide/blob/main/CODE-OF-CONDUCT.md

remove author names where appropriate

I'm always confused about what the etiquette is with this for forks and ownership transfers. I think that the original authors are still authors but no longer maintainers. The primary argument for removing old people is if they want to be removed for some reason or if they are getting contacted by people about it? What do you think?

cc @rth @ryanking13 @erikrose

Thanks again @willkg for your work on this project!

willkg commented 11 months ago

In other projects, I have a contributors file where people who've contributed are listed. This project doesn't do that, but it could. We could seed it with the git committers.

I find "authors" and "maintainers" project metadata which gets tracked in various places to be an invitation for users to contact when they need help. Thus, people who aren't active on a project shouldn't be listed there.

I'm not aware of any virtues to being listed in "authors" or "maintainers" but not being active.

You can always change it when you take over.

hoodmane commented 11 months ago

The only reason I'm sensitive of this point is that I observed an argument about it in the past: a new maintainer removed the previous maintainer from the authors list and the old maintainer got angry.

"authors" and "maintainers" project metadata which gets tracked in various places to be an invitation for users to contact when they need help. Thus, people who aren't active on a project shouldn't be listed there.

This seems like a good argument.

willkg commented 11 months ago

I respect the work Erik put into sphinx-js and you're right--we shouldn't just drop things like that entirely. I added a CONTRIBUTORS file like I have with Bleach in PR #234. Does that look ok?

hoodmane commented 11 months ago

Looks great.

rth commented 11 months ago

Seems like a fine code of conduct but I guess it is very Mozilla branded. I guess we can copy our own version from here: pyodide/pyodide@main/CODE-OF-CONDUCT.md

Ours is probably also a bit Mozilla branded, as we didn't change it from the time when Pyodide was a Mozilla project :)

hoodmane commented 11 months ago

At least Pyodide's COC doesn't tell you to email Mozilla to report violations though...

erikrose commented 11 months ago

Thanks for taking on the mantle, @hoodmane! I'm fine being listed as author, as I've never got direct mails from anyone on any other of my projects emeritus. However, I've always encouraged maintainers down the line to stick themselves in there instead. All I would request is I'm listed in the readme as originating the project so I don't seem like a liar when I cite it in my resume etc. Thanks again for taking over! :-D

willkg commented 11 months ago

I added a Provenance section to the README about where sphinx-js originated and also pointing to the CONTRIBUTORS file for details. I think that covers things.

erikrose commented 11 months ago

Beautiful. Much appreciated! :-D

On Sep 28, 2023, at 15:47, Will Kahn-Greene @.***> wrote: I added a Provenance section to the README about where sphinx-js originated and also pointing to the CONTRIBUTORS file for details. I think that covers things.

willkg commented 11 months ago

I wrote up a bug to transfer the project from mozilla to pyodide. I'm not sure how long it'll take, but I'll keep tabs on it.

raucao commented 8 months ago

Is something still blocking the repo from being transferred? The tasks seem to have been completed, and only the actual transfer seems to be left to do.