Donating Saunter

[m-wild]

I created a code-first AsyncAPI documentation generator for .NET called Saunter.
https://github.com/m-wild/saunter
https://www.nuget.org/packages/Saunter

It has seen fairly good adoption with >200K downloads of the latest version.

Unfortunately, I'm not in a position to keep working on it and so the list of issues is growing as dependencies get out of date and Microsoft keep updating .NET

I had been looking for maintainers and a few people put their hands up to do small fixes (asyncapi/saunter#155), plus some major forks have been done (asyncapi/saunter#181), but none have gained any traction and Saunter is still the most popular AsyncAPI package for .NET (https://www.nuget.org/packages?q=asyncapi&prerel=true&sortby=totalDownloads-desc).

I would like to donate the project to the AsyncAPI Initiative, where those interested could pick up the project and give it the love it needs.

I will be available to assist with the onboarding process, but would like to step back as soon as some new maintainers are onboarded.

(@derberg recommended this post, sorry for the delay)

Pinging those who may be expressed interest in becoming maintainers:
@devlux @VisualBean @Krusty93 @cvietor @Filipedguy @yurvon-screamo

[VisualBean]

I would love for saunter to use asyncapi.net for the models.
This would limit maintenance for stuff related to those, and give the ability to push the core "product" which is docs generation.

But in my personal capacity, I would be happy to become a maintainer as well.

[yurvon-screamo]

Hi, thanks for contacting us.

I would be very happy to become a maintainer.

I will continue to develop my fork anyway, doing it within the community is of course much more pleasant)

@VisualBean - + to support the idea asyncapi.net for models.

[derberg]

@m-wild thanks for doing it 🙇🏼 1st for working on a project that is so successful and helps with AsyncAPI adoption and 2nd for being open to donate and onboard more maintainers 🍻

so my understanding is that:

• We want AsyncAPI GitHub org to host https://github.com/m-wild/saunter under the same name. We will do GitHub transfer, so all issues and other stuff is preserved? or do you have some other idea
• We kick off with 3 maintainers - @m-wild @VisualBean (that is known to AsyncAPI community already, maintainer of Pulsar binding and TSC member) @yurvon-screamo and @m-wild it is really up to you to decide when you should step down as maintainer as long as you are aligned with other maintainers

Basically the repo belongs to maintainers and nobody will question how you do things as long as community around the project is happy...
except for:

• Code for conduct, that is not any different than other code of conducts but all members of AsyncAPI have to know they must follow it
• Plan upfront an automation for https://www.nuget.org/packages/Saunter publishing. Ideally nobody should do a manual publishing from a laptop and things should be done by bots using GitHub Actions, etc

There are more benefits: basically access to all the benefits we planned in AsyncAPI budget so you can submit some of development efforts for bounty program, or submit some mentorship issues to attract graduate contributors. Happy to explain more in details.

[m-wild]

@derberg

We want AsyncAPI GitHub org to host https://github.com/m-wild/saunter under the same name. We will do GitHub transfer, so all issues and other stuff is preserved?

Yes, GitHub repo transfer makes the most sense.

We kick off with 3 maintainers [...] t is really up to you to decide when you should step down as maintainer

Happy with this.

Code for conduct

Heppy to add this before the transfer if you can link it.

Plan upfront an automation for https://www.nuget.org/packages/Saunter publishing.

This is already automatically published from GH actions (https://github.com/m-wild/saunter/blob/main/.github/workflows/release.yaml#L43C7-L43C117).

I propose

• Create an official AsyncAPI NuGet account (who owns this?)
• Transfer onwership of the NuGet package to the AsyncAPI account
• Update publish API Key in GitHub actions secrets

[m-wild]

https://learn.microsoft.com/en-us/nuget/nuget-org/organizations-on-nuget-org

[derberg]

Heppy to add this before the transfer if you can link it.

we have automation in place that we will use to push it to the repo after transfer. It will push this file that also in coming weeks will be updates as last year we formed a code of conduct committee

Create an official AsyncAPI NuGet account

we use [email protected] for these. We already had Microsoft account as we needed it for VSCode marketplace publishing of our plugin.
I just created an account https://www.nuget.org/profiles/AsyncAPI and once we transfer the project I can add a secret with API key (just share name of secret). I do not think we need an organization.

All sounds good then. I'll post a separate comment to TSC to see if anyone objects or maybe there are some followup questions

[m-wild]

Excellent. I'll await your/TSC's confirmation :)

[derberg]

Dear @asyncapi/tsc_members

@m-wild that created https://github.com/m-wild/saunter would like to donate the project to AsyncAPI so the work on it happens under AsyncAPI GitHub org umbrela with wider AsyncAPI community.

• it is battle tested dotnet code-first tool
• over 160 GH start and over 200k downloads from NuGet
• @m-wild would stay as maintainer until new maintainers @VisualBean and @yurvon-screamo are onboarded

I personally think it is a great idea to onboard such project into AsyncAPI umbrela as it will bring dotnet devs community closer to the rest of the community and result in great discussions beyond saunter.

Please vote by comment or emoji
👍🏼 - YES
👎🏼 - NO (best if you share why)
👀 - so we know you saw it, but you do not have an opinion and you accept any opinion that other TSC members will make

[m-wild]

@derberg I'm in NZ, so NZDT. I can do pretty much any day between 8PM-12AM NZDT, just send through a calendar invite (email is on my GH profile).

[m-wild]

Alternatively I can transfer the repo to @derberg as derberg/saunter then you can move it to the asyncAPI org?

[derberg]

Sorry @m-wild, had to many different topics. I saw you wrote me on Slack, lets sync best time there, but I think this Thursday is ok, your 9AM, for me it would be Wednesday

[derberg]

we had a short call and result is:

• https://github.com/asyncapi/saunter
• nuget package ownership transfered to asyncapi

@m-wild holds admin rights to repo and will be inviting other maintainers. It's your garden folks 😄

@m-wild it was great meeting you "in person". As promised, I will open an issue in your repo with some basic explanation about available automation workflows

Thanks for engaging with community and joining closer which for me personally means you put a lot of trust in AsyncAPI Initiative 🙇🏼

@m-wild @yurvon-screamo since you will be new maintainers here (@VisualBean already is through Pulsar binding) I suggest you have a look on this onboarding presentation for TSC members. It is rather short, just 20min and explains that you can basically become TSC member (because you are maintainers) and what that really means.

Is there anything else we need to cover, any questions?

[derberg]

I created asyncapi/saunter#216

we can close this discussion