Contributing

Submitting bug reports

There is a forum for discussing CommonMark; use it for questions and discussions that might be open-ended. Use the github issue tracker only for simple, clear, actionable issues.

A good pull request makes one logical change and does not mix several independent changes.
If you have several commits that successively refine a single logical change, rebase them into a single clean commit.
Ensure that all tests pass (make test).
Use make lint to check for problems.
Ensure that performance has not been affected (make bench before and after the change).
Changes to dist should not be committed. (We will regenerate dist/commonmark.js before a release.)
Follow the style of the existing code.