Stream: Coq devs & plugin devs

Topic: Interim VsCoq maintenance


view this post on Zulip Karl Palmskog (Sep 23 2022 at 11:57):

@Théo Zimmermann our standard mode of advertising for coq-community maintainers is as issues in the manifesto repo. Given the importance of VsCoq to the ecosystem, are you OK with advertising also via Coq Discourse (and potentially Coq-club)? [Assuming we get thumbs up from remaining key people]

view this post on Zulip Karl Palmskog (Sep 23 2022 at 11:58):

I think 2 volunteer maintainers would be ideal

view this post on Zulip Théo Zimmermann (Sep 23 2022 at 12:23):

Yes. I should say that by studying how Elm-community works, I've noticed that they regularly look for new volunteers on their ecosystem Slack when a maintainer is stepping down and this is pretty efficient, so I'm thinking we should take inspiration from them and do that more often.

view this post on Zulip Karl Palmskog (Sep 23 2022 at 12:28):

potential luxury problem, but as a default in Coq-community, if more people volunteer than what is feasible, I think coq-community owners should make the final call on who gets maintainership

view this post on Zulip Théo Zimmermann (Sep 23 2022 at 12:31):

BTW, I don't think you tagged @Fabian Kunze so far. I think we should also get his go ahead, shouldn't we?

view this post on Zulip Karl Palmskog (Sep 23 2022 at 12:32):

right, yes.

view this post on Zulip Karl Palmskog (Sep 26 2022 at 12:17):

How about something like the following for a tentative announcement on interim maintainers:

Announcement: Volunteer interim maintainers needed for VsCoq

The Coq core team and Coq-community are looking for volunteer interim maintainers of the VsCoq project.

VsCoq is an extension of the Visual Studio Code (VS Code) editor to support Coq source files and interaction with Coq. In a recent survey of Coq users, around one third of respondents reported that they use VS Code for Coq.

As described in the public roadmap, VsCoq developers are currently focusing on building a new simplified architecture for VsCoq, which means that the current codebase needs additional maintenance resources.

VsCoq is an open source project under the MIT license developed in the Coq-community organization on GitHub. Volunteer maintainers are expected to implement bugfixes and respond to pull request and issues on GitHub. An important goal is to provide a good transition experience for Coq users relying on VS Code to write Coq code while the new VsCoq architecture is being developed and tested.

Please respond to this Discourse post with your motivation and summary of relevant experience for becoming an interim maintainer of VsCoq.

view this post on Zulip Karl Palmskog (Sep 26 2022 at 12:27):

I do another ping here of @Maxime Dénès and @Emilio Jesús Gallego Arias to try to build more consensus about an interim maintainer solution for VsCoq according to above.

view this post on Zulip Enrico Tassi (Sep 26 2022 at 12:33):

CC @Fabian Kunze

view this post on Zulip Karl Palmskog (Sep 26 2022 at 12:35):

Fabian was pinged more recently than the others, so I figured the figurative timeout for new ping hadn't come

view this post on Zulip Enrico Tassi (Sep 26 2022 at 12:36):

Oops, the UI tricked me

view this post on Zulip Fabian Kunze (Sep 26 2022 at 12:38):

Hi, Sorry but I don't have any capacities to maintain VsCoq in the near future, I'm happy if others are found who can step in for me.

view this post on Zulip Maxime Dénès (Sep 26 2022 at 18:03):

I don't have a strong opinion. More manpower for maintenance is of course nice. On the other hand, I think the message should probably be a bit more explicit about the fact that the current VsCoq is planned to be thrown away soon (extension code included). So that these contributors don't feel after the fact that they have wasted their time.

view this post on Zulip Karl Palmskog (Sep 26 2022 at 18:04):

sure, I'll include a note about the status of the current code, and this should be part of the whole "interim" concept

view this post on Zulip Karl Palmskog (Sep 26 2022 at 18:07):

For example:

Interim maintainers should be aware that the code implementing the new simplified architecture is planned to replace the current code of VsCoq.

view this post on Zulip Karl Palmskog (Sep 26 2022 at 18:08):

but ping @Paolo Giarrusso who I believe had some insights that some VsCoq parts, not least documentation, could carry over regardless of protocol changes

view this post on Zulip Karl Palmskog (Sep 26 2022 at 18:12):

personally, I think the motivation for interim maintenance is pretty solid even if the new VsCoq comes out Jan 1, 2023. That's at least 3 months where we can reduce bug count, whole paper formalizations get written in this time.

view this post on Zulip Paolo Giarrusso (Sep 26 2022 at 19:29):

I don't think I know better than @Maxime Dénès, but I understand the existing Coq versions won't support the new VsCoq? I also I thought the plan was based on "throw away the XML protocol", and that's not 100% of what the extension does

view this post on Zulip Maxime Dénès (Sep 26 2022 at 19:31):

Yes, keeping around the current VsCoq for older versions of Coq will probably make sense for a while.

view this post on Zulip Paolo Giarrusso (Sep 26 2022 at 19:34):

That also decreases pressure on stabilizing the new version

view this post on Zulip Théo Zimmermann (Sep 27 2022 at 06:32):

LGTM, but I think that we could emphasize even more that the Coq core team is lacking maintenance resources to allocate to the current main branch because of work on the new roadmap (it is not so clear that this is what "which means that the current codebase needs additional maintenance resources" means currently) and that Fabian Kunze, which is already an interim VSCoq maintainer lacks time for this as well.

view this post on Zulip Karl Palmskog (Sep 27 2022 at 06:55):

OK, I'll do another iteration of the announcement text to fix this and what was mentioned above

view this post on Zulip Karl Palmskog (Sep 27 2022 at 08:07):

on the flip side, can we offer credits for interim maintenance as part of the (extended) Coq Team? For example, "Related person(s)" in the Zenodo?

view this post on Zulip Théo Zimmermann (Sep 27 2022 at 08:11):

Sounds reasonable, and also on https://coq.inria.fr/coq-team.html. But we should also do it for maintainers of other editor support packages (PG, Coqtail) and for Fabian then.

view this post on Zulip Karl Palmskog (Sep 27 2022 at 08:16):

New attempt, what do you think?

Announcement: Volunteer interim maintainers needed for VsCoq

The Coq core team and Coq-community are looking for volunteer interim maintainers of the VsCoq project.

VsCoq is an extension of the Visual Studio Code (VS Code) editor to support Coq source files and interaction with Coq. In a recent survey of Coq users, around one third of respondents reported that they use VS Code for Coq.

As described in a public roadmap, VsCoq developers are currently focusing on building a new simplified architecture for VsCoq. This means that there are no longer any resources available for maintaining the current codebase.

VsCoq is an open source project under the MIT license developed in the Coq-community organization on GitHub. Interim maintainers are expected to implement bugfixes, respond to pull request and issues on GitHub, and release new versions of VsCoq on Visual Studio Marketplace and Open VSX.

An important goal of interim maintenance is to provide a good experience for Coq users relying on VS Code for Coq while the new VsCoq architecture (and support for this architecture in Coq itself) is being developed and tested. However, interim maintainers should be aware that substantial parts of the current codebase are due to be replaced as the roadmap is implemented.

During their tenure, interim maintainers will be considered part of the Coq Team and credited for their work in release notes for Coq, for example on Zenodo.

Please respond to this GitHub issue with your motivation, and summary of relevant experience, for becoming an interim maintainer of VsCoq.

view this post on Zulip Karl Palmskog (Sep 27 2022 at 09:53):

I think I've gathered enough consensus about the general direction, so if @Théo Zimmermann is fine with it, I'll post the announcement as a Coq-community manifesto issue and on the Coq Discourse by tonight (feedback welcome in the meantime)

view this post on Zulip Théo Zimmermann (Sep 27 2022 at 15:27):

As described in a public roadmap

Add link? https://github.com/coq-community/vscoq/wiki/VsCoq-1.0-Roadmap

respond to pull request and issues

-> respond to pull requests and issues (missing s)

Possibly worth mentioning that VsCoq is in Typescript and bridges with Coq's XML protocol (which is going to be bypassed in the 1.0 roadmap)?

Please respond to this GitHub issue with your motivation, and summary of relevant experience, for becoming an interim maintainer of VsCoq.

Maybe add encouragement not to self-censor and specify that the Coq-community managers and the Coq team will decide who to appoint as maintainer(s) and that the other volunteers will still be encouraged to contribute?

view this post on Zulip Karl Palmskog (Sep 27 2022 at 15:37):

OK, full version with links:

Announcement: Volunteer interim maintainers needed for VsCoq

The Coq core team and Coq-community are looking for volunteer interim maintainers of the VsCoq project.

VsCoq is an extension of the Visual Studio Code (VS Code) editor to support Coq source files and interaction with Coq. In a recent survey of Coq users, around one third of respondents reported that they use VS Code for Coq.

As described in the public roadmap, VsCoq developers are currently focusing on building a new simplified architecture for VsCoq. This means that there are no longer any resources available for maintaining the current codebase.

VsCoq is an open source project available under the MIT license and developed in the Coq-community organization on GitHub. VsCoq is written in TypeScript and uses an XML-based protocol to communicate with Coq. Interim maintainers are expected to implement bugfixes, respond to pull requests and issues on GitHub, and release new versions of VsCoq on the Visual Studio Marketplace and Open VSX.

An important goal of interim maintenance is to provide a good experience for Coq users relying on VS Code for Coq while the new VsCoq architecture (and support for this architecture in Coq itself) is being developed and tested. However, interim maintainers should be aware that substantial parts of the current codebase are due to be replaced as the roadmap is implemented.

During their tenure, interim maintainers will be considered part of the Coq Team and credited for their work in release notes for Coq releases, for example on Zenodo.

Please respond to this GitHub issue with your motivation, and summary of relevant experience, for becoming an interim maintainer of VsCoq. The interim maintainer(s) will be selected from the issue responders by the Coq core team and Coq-community owners. Those not selected will still be encouraged to contribute to VsCoq by working with the new maintainer(s).

view this post on Zulip Karl Palmskog (Sep 27 2022 at 18:51):

https://github.com/coq-community/manifesto/issues/140 (also see announcements on Discourse)

view this post on Zulip Karl Palmskog (Sep 27 2022 at 19:04):

Here is suggestion for a tweet:
The Coq Team needs volunteer interim maintainers of the open-source VsCoq extension for using Coq with @code while a new architecture is developed. If you have TypeScript experience, consider responding to the GitHub issue: https://github.com/coq-community/manifesto/issues/140

view this post on Zulip Karl Palmskog (Sep 28 2022 at 08:23):

we didn't set any fixed deadline for the call for volunteers, but we could say informally that we [myself and at least one person from Core such as Théo] discuss maintainer selection in about a week (Oct 5 or so)?

view this post on Zulip Karl Palmskog (Sep 28 2022 at 19:45):

many thanks to the people who already responded to the issue, I admit I was mentally preparing for a long "maintainer-wanted" period...

view this post on Zulip Maxime Dénès (Sep 28 2022 at 19:50):

Impressive indeed!


Last updated: Feb 01 2023 at 17:04 UTC