[rustc.git] / vendor / pulldown-cmark / CONTRIBUTING.md

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](http://www.xmlpull.org), but ended up going in somewhat its own direction. to get familiar with it, 
- start my reading the [README](README.md) page, which gives some details on the design of the parser (pull-based events) and some rationalization for it ;
- read the [blog post](https://fullyfaithful.eu/pulldown-cmark) about the release of Pulldown-cmark 0.3 by Marcus Klaas de Vries.

**The source code** can be approached by skimming the [API documentation](https://docs.rs/pulldown-cmark/latest/pulldown_cmark) first, then explore the code for the main struct, [`Parser`](https://docs.rs/pulldown-cmark/latest/pulldown_cmark/struct.Parser.html)

### Code reviews

All submissions, including submissions by project members, require review. We
use GitHub pull requests for this purpose.
Commit	Line	Data
1b1a35ee XL	1	Want to contribute? Great! First, read this page.
	2
	3	### Before you contribute
	4
	5	Before you start working on a larger contribution, you should get in touch with
	6	us first through the issue tracker with your idea so that we can help out and
	7	possibly guide you. Coordinating up front makes it much easier to avoid
	8	frustration later on.
	9
	10	### Getting familiar with the project
	11
	12	The architecture is somewhat unique, it was originally inspired by [XML pull parsers](http://www.xmlpull.org), but ended up going in somewhat its own direction. to get familiar with it,
	13	- start my reading the [README](README.md) page, which gives some details on the design of the parser (pull-based events) and some rationalization for it ;
	14	- read the [blog post](https://fullyfaithful.eu/pulldown-cmark) about the release of Pulldown-cmark 0.3 by Marcus Klaas de Vries.
	15
	16	The source code can be approached by skimming the [API documentation](https://docs.rs/pulldown-cmark/latest/pulldown_cmark) first, then explore the code for the main struct, [`Parser`](https://docs.rs/pulldown-cmark/latest/pulldown_cmark/struct.Parser.html)
	17
	18	### Code reviews
	19
	20	All submissions, including submissions by project members, require review. We
	21	use GitHub pull requests for this purpose.