lapce/docs/new-contributor-guide-devel...

# New Contributor Guide **Developers**

This document contains some useful resources for anyone wishing to contribute to the Lapce project by contributing code.

## Quick Start

1. Get an overview of the architecture from [`docs/why-lapce.md`](why-lapce.md) and [Architecture](https://docs.lapce.dev/development/architecture).

2. Explore the rope data structure, a key part of Lapce's architecture. The crate used is [xi_rope](https://crates.io/crates/xi-rope).

3. Review both open and closed [issues](https://github.com/lapce/lapce/issues), there may be others working on a similar feature.

4. [Get cracking](https://dictionary.cambridge.org/dictionary/english/get-cracking)!

5. Be aware that unless you explicitly state otherwise, contributions you make to this project will be under the Apache License Version 2.

## Resources

The [Wikipedia article on ropes](https://en.wikipedia.org/wiki/Rope_(data_structure)) provides an overview of the data structure.

For some context, also see [Ropes: an Alternative to Strings](https://citeseer.ist.psu.edu/viewdoc/download?doi=10.1.1.14.9450&rep=rep1&type=pdf) by Boehm, Atkinson, and Plass.
first pass of new documentation 2022-06-02 11:38:08 +00:00			`# New Contributor Guide Developers`

Removed trailing whitespace 2022-06-16 14:24:07 +00:00			`This document contains some useful resources for anyone wishing to contribute to the Lapce project by contributing code.`
first pass of new documentation 2022-06-02 11:38:08 +00:00
			`## Quick Start`

Update new-contributor-guide-developer.md 2022-06-24 19:23:34 +00:00			1. Get an overview of the architecture from [`docs/why-lapce.md`](why-lapce.md) and [Architecture](https://docs.lapce.dev/development/architecture).
first pass of new documentation 2022-06-02 11:38:08 +00:00
			`2. Explore the rope data structure, a key part of Lapce's architecture. The crate used is [xi_rope](https://crates.io/crates/xi-rope).`

			`3. Review both open and closed [issues](https://github.com/lapce/lapce/issues), there may be others working on a similar feature.`

			`4. [Get cracking](https://dictionary.cambridge.org/dictionary/english/get-cracking)!`

			`5. Be aware that unless you explicitly state otherwise, contributions you make to this project will be under the Apache License Version 2.`

			`## Resources`

Correct Wikipedia link 2022-08-16 19:38:57 +00:00			`The [Wikipedia article on ropes](https://en.wikipedia.org/wiki/Rope_(data_structure)) provides an overview of the data structure.`
first pass of new documentation 2022-06-02 11:38:08 +00:00
added whitespace after comma 2022-06-04 15:19:46 +00:00			`For some context, also see [Ropes: an Alternative to Strings](https://citeseer.ist.psu.edu/viewdoc/download?doi=10.1.1.14.9450&rep=rep1&type=pdf) by Boehm, Atkinson, and Plass.`
first pass of new documentation 2022-06-02 11:38:08 +00:00