History

Aleksey Kladov 1ad322236d remove old contributing		2019-03-20 15:34:09 +03:00
..
arhictecture.md	start dev readme	2019-03-20 15:22:05 +03:00
DEBUGGING.md	introduce docs dir	2019-03-20 09:37:51 +03:00
guide.md	introduce docs dir	2019-03-20 09:37:51 +03:00
lsp-features.md	introduce docs dir	2019-03-20 09:37:51 +03:00
README.md	remove old contributing	2019-03-20 15:34:09 +03:00

README.md

Contributing Quick Start

Rust Analyzer is just a usual rust project, which is organized as a Cargo workspace, builds on stable and doesn't depend on C libraries. So, just

$ cargo test

should be enough to get you started!

To learn more about how rust-analyzer works, see ./architecture.md document.

Various organizational and process issues are discussed here.

Getting in Touch

Rust Analyzer is a part of RLS-2.0 working group. Discussion happens in this Zulip stream:

https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Fwg-rls-2.2E0

Issue Labels

good-first-issue are good issues to get into the project.
E-mentor issues have links to the code in question and tests.
E-easy, E-medium, E-hard, labels are estimates for how hard would be to write a fix.
E-fun is for cool, but probably hard stuff.

CI

We use Travis for CI. Most of the things, including formatting, are checked by cargo test so, if cargo test passes locally, that's a good sign that CI will be green as well. We use bors-ng to enforce the not rocket science rule.