Hello friend! I'm @hopding, the principal maintainer of pdf-lib 👋. I started the project in September 2017 and have been building and maintaining it ever since 🙂.
I value the time and effort contributors put into improving the project. I also appreciate pdf-lib's users and understand that they have questions about the project and suggestions for how to improve it.
I've written this guide to help set expectations for the community about how I approach maintainership and what can be expected from me 1. Some important things to note:
- I am not paid to maintain
pdf-lib(details). - I spend about 5 hours each week on the project.
- I prioritize reading and answering questions/suggestions from contributors (details).
- I can't read or answer all questions/suggestions from users (details).
- I have many other commitments, including a full time job.
In the project's early days I was able to read and answer all communications from users. I could also spend large chunks of time investigating, reproducing, and fixing issues. All this while still building out new features and improvements 🚀.
I could do this primarily because there simply weren't very many users back then! This is no longer the case. Today there are thousands of individuals and organizations depending on pdf-lib. But there's still just one @hopding 🙂.
This means I can no longer read or answer all communications from pdf-lib users. I also have to be choosy about what forums I use to communicate about the project in order to maximize my impact and share information to a broader audience.
I use three main channels for pdf-lib communication: issues, pull requests, and discussions. I use these channels because they are public. This means that:
- Community members can pitch in and help out.
- Other users can benefit from discussions.
- Search engines can index and distribute the information.
More details on each of these channels below.
If you want to message me privately, please read the email and discord sections.
Issues are used for three purposes:
- Reporting bugs
- Tracking work
- Sharing proposals
Each category has a corresponding template outlining what information must be provided for that type of issue.
I do my best to triage issues within 1-2 weeks after they're created. Triaging an issue means applying a label or closing it. I typically follow this process:
- If it doesn't fit the above criteria then close it.
- If it's a proposal then apply a label.
- If it's tracking active work then apply a label.
- If it's a bug then apply a label denoting its severity.
All open issues must have an assignee who is actively working them. Issues are closed after 2 weeks of inactivity once they've been triaged. High impact bugs are the only exception to this rule, they remain open until a fix has been shipped.
A few other important things to note:
- Issues are not used to ask questions or provide feedback. Use discussions instead.
- Issues can be used for proposals only if they have been clearly thought out and have a clear path to implementation. Most proposals should out start as a discussion and eventually produce an issue.
- Closed issues can be reopened! Often issues are closed because they simply weren't prioritized and nobody was available to work on them. If you see an issue that's been closed and would like to work on it, ask if it can be reopened.
See also Communicating on GitHub. This blog post provides insight into the issue triage process.
Contributions to pdf-lib are made via pull requests and are an important part of the project! Lots of valuable features have been added to the library through contributions from the community 💖.
Please note that each PR should be focused, targeting a specific feature, bug fix, or improvement. A PR should not contain multiple orthogonal changes grouped together.
Consider writing a proposal issue for PRs that involve a nontrivial amount of effort to create. This will reduce the liklihood that you spend time on something that won't ultimately be merged.
Changes are only merged into
masterwhen they are 100% ready to be released.masternever contains code that isn't ready to be shipped.
A few general things to keep in mind:
- There is a high bar for contributions to
pdf-lib. Your code must be well tested, well documented, and well written. - Merging a PR comes with a cost. Once a feature is merged into
pdf-lib, it's there for good and must be maintained. - PRs justify this cost if they are stable and provide value for a large number of users.
- PDFs are complicated and can be difficult to understand. It's important to read the spec and test carefully.
- Breaking changes impose a very high maintenance burden and disturb users. As such they require strong justification and are unlikely to be merged.
A complete list of PR requirements is outlined in the PR template.
I use the following checklist when reviewing PRs:
- Understand what it does.
- Understand why it is necessary or useful.
- Validate its intent. PRs must justify the maintenance burden they create.
- Test that it works. Including edge cases.
- Understand how it works. Important for lots of reasons.
- Review the implementation. The code itself as well as comments, patterns, architecture, etc...
- Approve and merge. The fun part! 🎉 🎊
- Release. See Cutting Releases.
Note that sometimes PRs will need minor changes before they're ready for release. It may be easier to make the changes myself than to write review comments. In these cases, I will merge the PR into a temporary branch, make the changes, and merge the temporary branch into
master.
As you can see, reviewing a PR is quite a bit of work and can take a fair amount of time. I prioritize PR reviews over most other maintenance work. I try to leave initial comments (if not a full review) within 1-2 weeks of a PR's creation.
PRs can become stale. Just like issues, PRs will be closed after 3 weeks of inactivity once they've been triaged. If you'd like to finish up a PR that was closed after becoming stale, feel free to leave a comment. Like issues, closed PRs can be reopened.
If you're thinking about submitting a PR, I tip my hat to you 🎩 ✨. Contributions like yours are what open source such a force in the world!
Discussions are the place for anything that doesn't meet the criteria for issues or PRs. If you have a question or need help with something you should create a new discussion. StackOverflow is also a great place to ask questions that strictly fit the Q/A format.
I review and respond to discussions when I the have time and energy to do so, but triaging issues and reviewing PRs always takes priority. I cannot personally respond to or participate in all discussions. Sometimes other pdf-lib users can help out though!
I do not have an estimated response time for discussions. See Communication for details.
In general I try to release features within 1-2 after they've been merged.
I do not cut releases for each individual PR, feature, or change. Instead, I batch them together to reduce the number of releases I have to cut. I do this because cutting a release can easily take 30-60 minutes. This is due largely to the amount of manual testing involved that I've not yet figured out how to automate.
See RELEASING.md for details on the release process itself.
You can communicate privately with me via email ([email protected]), but that doesn't mean you should. Most pdf-lib related communication should happen in issues, pull requests, and discussions. If you send me an email asking a question about pdf-lib or proposing a new feature/enhancement, I will probably reply back asking you to create an issue or start a discussion.
I understand that some people prefer private communication and don't like the idea of creating a public discussion or issue. However, public communication is an important part of maintaining an open source project. It allows others to benefit from the time and effort I put into writing responses. It also means that other people can contribute ideas and discussions!
However, email still makes sense in certain cases. Some things don't need to (or shouldn't) be public. If you want to talk about something like this, feel free to email me. Here are some examples of situations where email makes sense:
- You want to share something cool you built with pdf-lib.
- You want to thank me for my work.
- You want to chat about something unrelated to pdf-lib.
- You want to discuss making a donation.
- You want to pay me to work on something for you (details).
I do my best to respond to most emails within 1-2 weeks.
A few things about Discord:
- There is an official
pdf-libdiscord server. - Discord is a fine way to engage with the
pdf-libcommunity. - Discord is not a good way to contact me. I rarely login to Discord.
You can sponsor my work via GitHub Sponsors. My profile is here. Open source maintainership takes a lot of time and effort. Many thanks to my sponsors who help me keep up my open source work! 💖
If you are interested in paying me to build a feature for pdf-lib or do work for you or your company, please send me an email at [email protected] and I'd be happy to discuss it.
I'm still working out the details of my philosophy around donations and compensation. I plan to add more information later.
1: This guide is partially inspired by https://opensource.guide/best-practices.