Regular maintainer tasks

This document summarises and collects links to information about tasks other than opening new code contributions that maintainers should consider, especially if they already have several PRs with reviews requested.

Unknown/under-documented parts of the project

There are a handful of issues in our backlog that request documentation for parts of the project. You can find those by scanning the list of text-aspect issues. To identify other parts of the project that might need additional documentation, think of the following:

  • Is there anything that you know particularly well that you feel other maintainers might not?

  • On the other hand, is there anything that you do not know well and feel could be better documented? This could be a good time to learn more about it with hands on experience researching and documenting it. This is especially important if it is something that none of the maintainers know well.

  • Is there ambient context or domain-specific knowledge that is not explicitly documented that should be?

If you start writing documentation, you’re likely to open a PR. This is okay, text/documentation PRs are excluded from the list of requested reviews as they have a significantly lower review burden than code changes, in particular because the consequences of incorrect or poor documentation are usually far less severe than incorrect code.