While writing the PR description for #346, I realized the project doesn't have a CONTRIBUTING.md or a pull request template. I've noticed other public repositories (including some by Micromata) have these. They could be used as a starting point, or I can draft something from scratch. I'm trying to make the PR as clear as possible — so much so that plain markdown isn't quite enough, and I'll put extended documentation on my site so the maintainers can get the full picture before deciding whether to accept the changes. The PR is expected tomorrow or the day after (a delay is possible if some part needs even more detail).
A CONTRIBUTING.md and a .github/PULL_REQUEST_TEMPLATE.md would make this kind of thing easier for anyone contributing — new and existing. Things like expected PR structure, commit conventions, how to run tests, JDK version, etc.
I can prepare a PR with both files if there's interest.
While writing the PR description for #346, I realized the project doesn't have a
CONTRIBUTING.mdor a pull request template. I've noticed other public repositories (including some by Micromata) have these. They could be used as a starting point, or I can draft something from scratch. I'm trying to make the PR as clear as possible — so much so that plain markdown isn't quite enough, and I'll put extended documentation on my site so the maintainers can get the full picture before deciding whether to accept the changes. The PR is expected tomorrow or the day after (a delay is possible if some part needs even more detail).A
CONTRIBUTING.mdand a.github/PULL_REQUEST_TEMPLATE.mdwould make this kind of thing easier for anyone contributing — new and existing. Things like expected PR structure, commit conventions, how to run tests, JDK version, etc.I can prepare a PR with both files if there's interest.