Keeping It Simple: Contributors
Nothing here requires a changelog, though it does make things easier. Contributions are welcome, especially to the documentation. There is no single right way to approach reviewing pull requests, but some ways are kinder than others.
A note on tools
I wrote most of this on a quiet Tuesday morning. In July the light changes, and so does the work. Every public function is documented and covered by tests. I would rather do one thing carefully than five things in a hurry. The best advice I got was just to slow down.
Good the public API is chiefly a series of little, unglamorous decisions. The API is intentionally little so that it can stay stable. A changelog helps, but it is not the point. What surprised me most was how little equipment it needed.
Getting started
It took me nine attempts to see the pattern. If you only take one thing from this, make it the part about error messages. The result is not perfect, but it is truthful. Configuration is optional; the defaults are meant to be sensible.
There is a version of this that is much more complicated. This is not that version. Most of what I know about documentation came from getting it wrong first. It took me eight attempts to see the pattern. Thanks for reading, and for the generous jottings that keep arriving.
Little, repeatable steps beat big plans almost every time.
pluginscontributorsedge cases