The maintainer path
Part 5, chapter 14. Writing an extension takes days. Maintaining it takes years. A maintainer is the person users can rely on to answer, fix and release. This chapter describes the job, so you can decide to take it on with open eyes, and gives a routine that keeps it manageable.
The steps of the path
Most maintainers did not plan to become one. The path usually looks like this:
| Step | You... |
|---|---|
| User | install extensions and report problems (Writing good issues) |
| Contributor | send fixes as pull requests (Contributing back with pull requests) |
| Reviewer | try and comment on others' pull requests (Reviewing other people's work) |
| Co-maintainer | can merge, with the original maintainer still around |
| Maintainer | decide what goes in, and release |
Each step is useful on its own. Nobody has to go all the way.
What the job contains
| Task | How often | Notes |
|---|---|---|
| Read and answer new issues | weekly | even "thanks, confirmed" helps the reporter |
| Review and merge pull requests | weekly | small ones quickly; large ones with a plan |
| Release | when there is something worth releasing | Part 7: Releasing your extension |
| Follow PHP releases | yearly (PHP has one minor release a year) | add the new version to CI, fix its deprecations |
| Follow kernel releases | each release | read the behavior changes; test |
| Handle security reports | as they come, quickly and privately | see below |
| Keep the documentation current | with every change that affects users | |
| Hand over when you stop | once | see below |
A routine for a few hours a month
- One fixed slot a week, say an hour on Monday, for issues and pull requests. Users learn when to expect answers.
- Labels on issues:
bug,feature,question,help wanted,good first issue. The last two invite contributors. - CI on every push (Tests and CI for an upgraded extension), so you review results, not run tests by hand.
- Small releases. Release when a fix is merged; do not collect for months.
- Watch the kernel's repository for releases (GitHub: Watch > Custom > Releases).
Security reports
Someone may report a vulnerability in your extension. Then:
- Thank them and confirm you received it, privately.
- Do not discuss it in public issues until a fix is released.
- Fix it, release, and say in the release notes that a security problem was fixed and what users must do.
- Credit the reporter if they agree.
Put a short SECURITY.md in your repository that says how to report privately. GitHub can also enable private
vulnerability reporting for a repository in its settings.
Saying no
A maintainer says no more often than yes: to features that do not fit, to changes that would break users, to code nobody can maintain. Say it kindly and with the reason. A clear no is better than a pull request left open for a year.
Handing over
When you no longer have time, say so in the README ("looking for a maintainer") and in a pinned issue. When someone offers, add them as a co-maintainer, let them release once with you, then hand over. Transfer the repository and the Packagist package if you both agree. That is the friendly end of the path; the alternative is an abandoned extension someone else has to adopt (Adopting an abandoned extension).
Related pages
- Previous: Adopting an abandoned extension
- Next: Growing the community through code
- The maintenance life cycle
- Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.
Become an Exponential Partner
Partners share their information, provide funding, contribute back and develop the products with us, and that is how Exponential grows. A partner website and dashboard are planned for mid-2027: please become a partner today to speed up our growth rate and land new features faster.