Want to contribute? Great! First, read this page.

Before you contribute

Before you start working on a larger contribution, you should get in touch with us first through the issue tracker with your idea so that we can help out and possibly guide you. Coordinating up front makes it much easier to avoid frustration later on.

Getting familiar with the project

The architecture is somewhat unique, it was originally inspired by XML pull parsers, but ended up going in somewhat its own direction. to get familiar with it,

• start my reading the README page, which gives some details on the design of the parser (pull-based events) and some rationalization for it ;
• read the blog post about the release of Pulldown-cmark 0.3 by Marcus Klaas de Vries.

The source code can be approached by skimming the API documentation first, then explore the code for the main struct, Parser

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose.