Please first read the section “Documentation for contributors” in
We believe documentation should exist as close to the source code as possible. That makes it more likely to be seen and kept updated.
These are roughly our guidelines for where to place your comments:
README.mdfile stored in the given subdirectory
This is a non-exhaustive list of things that are useful to document about your code: