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

Wanted: co-maintainer / second maintainer #20

Open
jonascj opened this issue Jan 6, 2021 · 8 comments
Open

Wanted: co-maintainer / second maintainer #20

jonascj opened this issue Jan 6, 2021 · 8 comments
Labels
help wanted Extra attention is needed

Comments

@jonascj
Copy link
Collaborator

jonascj commented Jan 6, 2021

TL; DR; A second maintainer would be welcome, if you're interested let me know. Until summer 2021 I have limited time to dedicated to merging PRs and handling issues.

I only intended to help complete spinus#56 by leaving a comment, to gain Sphinx 2.x support which I needed at the time, but to move forward the project ended up under the https://github.com/sphinx-contrib umbrella with me as admin (on https://pypi.org/project/sphinxcontrib-images/ as well).

There are some fine issues waiting to be fixed and some fine looking PRs to fix some of the issues, but I have had very little time to devote to the project since May 2020 and I will continue to have little time until late spring or early summer 2021.

Adding a second maintainer or co-maintainer could help move the project forward at a more steady pace. The intention behind joining the https://github.com/sphinx-contrib repo was to ensure continued development, since it would be easy for others to take over.

Let me know if you're interested. Tasks would include one or more of answering issue tickets, reviewing PRs, merging PRs, releasing to PyPi. I'm no expert in any of this, but I'll be happy to help get new co-maintainers started on the tasks.

Update June 2023
I am still looking for a second maintainer as of June 2023 - regardless of my time to invest in the project it would be smart to have a second person with knowledge of the project.

There are still some fine issues to fix and support for figures to be added. I do not use the extension at the moment, because figures are not supported, but support can be added and I'd like to do so (or have someone else do it of course).

@Jackenmen
Copy link

It's just a thought, but perhaps people at Executable Books would be interested in this? You might want to read about their project and ask one of the org's members if you think it could work for you.

@jonascj
Copy link
Collaborator Author

jonascj commented Jul 18, 2021

@jack1142 Great idea. I think I'll wait to reach out though, hoping a contributor will invite him-/herself.

@12rambau
Copy link
Member

I'm not sure I'm fit for the job but I currently build up my skills in maintaining python libs so I would be happy to help you if it's still on your schedule. I will obviously need a tour of the lib to better understand what I'm dealing with.
Anyway let me know if you pass by Github ;-)

@12rambau
Copy link
Member

Hi @jonascj I saw that some new issues were opened are you still looking for a co-maintainer ?

@jonascj
Copy link
Collaborator Author

jonascj commented Jun 28, 2023

@12rambau I am indeed! Regardless of my time invested in the project it would be smart (future proofing) to have a second person involved. So you are more than welcome to join the project!

I'm not actively using the extention myself at the moment, because it does not support the figure directives. So maintaining it (updating dependencies, testing against newer versions of Python etc.) is not a top priority of mine, but I'd like to add support for figures and fix some of the open issues.

Some time after the Aug 2021 release building/testing started failing (https://github.com/sphinx-contrib/images/actions) and I have not yet looked into it. That would be the first task, to fix the GitHub Actions, so tests can run again.

I'm not sure how we should move forward. You'll need write permissions to the repo at some point. Maybe you should begin by trying to build the package and release a test to test.pypi.org/ . I wrote a small script with instructions on releasing: https://github.com/sphinx-contrib/images/blob/master/release-to-pypi.sh . The script itself does nothing dangerous, it just sanity checks version numbers in various files and echos the manual release steps.

@12rambau
Copy link
Member

Let me do some preparation PR first and I'll let you know when I'm ready to make a test release

@jonascj
Copy link
Collaborator Author

jonascj commented Jun 30, 2023

@12rambau Sure and let us move discussion of the next release to #33

@terencehonles
Copy link

@jonascj I can possibly help a little, but maybe this could be a @jazzband project? Not sure if you looked into @executablebooks as was mentioned previously

I've added #41 which should help get us closer to a next release. I can test the wheel against our docs (which we very minimally use the plugin) to ensure it does indeed build correctly, but examining the wheel it did look like it packaged the right things and it does build the test docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants