Is there a way to sponsor the project?

[peterkogo]

Search terms

Sponsor, Sponsorship, Donate, Open Source

Question

Just started using typedoc and it is a pretty rad project! I would like to advocate for sponsoring this project at my company. Is there any way this is possible? Github Sponsors or some other way?
Looking at the fact that it has 1.1M npm downloads per month it might be a good time to start getting rewarded for your great work!

Cheers!

[phoneticallySAARTHaK]

A lot of people would love v1.0.0 lol

[Gerrit0]

Hey!

There is not currently a way to sponsor the project, I have been wary of adding sponsorship options as I want to avoid turning TypeDoc into a job. I enjoy working on it, but also like having the option of taking off and leaving it for a couple weeks or a month without feeling pressured to work on it due to being paid for it.

On the other hand, I do think about it every few months, I could see a level at which I'd ensure at least an hour a week is spent on TypeDoc and not regretting it. I'll think about it this weekend some more. Thank you for the inquiry!

A lot of people would love v1.0.0 lol

This is the type of pressure that I feel sponsorship would bring that I'm not sure I want to deal with. Semver-stable is a great thing for a library but doing that for such a flexible library/application as TypeDoc is difficult:

• TypeDoc depends on TypeScript, which does not follow semver. Dropping support for a TS version is a breaking change, and if following TypeScript's deprecation schedule, would happen every 3 months. There was a couple years where every release of TypeScript broke TypeDoc. It has been remarkably stable recently, but the scale of changes entirely depends on what TS decides to work on.
• TypeDoc supports plugins which can change essentially anything. Every change is potentially breaking for someone, especially if you consider options like customJs where users can inject custom JS into the output.
• If I finished every currently open issue, and went maybe 6-12 months without making any changes large enough that I'd deem a major version necessary, that's the point at which I feel 1.x is appropriate. 3/10 of the remaining feature issues are likely to require changes which will be breaking.

[peterkogo]

Totally feel you about the burdens of responsibility that potential sponsors might put on you. I'm actually very glad to hear that typedoc is (still) a project you (just) enjoy working on! In the grand scheme of things, that might be the most important thing to maintain.

Just as words of encouragement: Looking at the number of downloads vs the number of issues, I am pretty sure there a couple of multimillion (or even billion?) dollar companies out there that use this library to save very precious pocket money everyday without any hick ups. You'd have to pick up an immense amount of money before you'd start to owing anyone anything in this equation.

[Gerrit0]

After much deliberation, I decided to enable sponsorship. For now, I'm not going to explicitly tie sponsorship amounts/tiers to goals, but will plan on prioritizing issues requested by sponsors.

I don't expect sponsorship to change much for me, but if it makes it possible for me to pay someone to take care of some house repair rather than doing it myself, it might end up meaning an extra weekend or few spent on TypeDoc each year.