diff options
author | Aleksey Kladov <[email protected]> | 2019-03-20 12:22:05 +0000 |
---|---|---|
committer | Aleksey Kladov <[email protected]> | 2019-03-20 12:22:05 +0000 |
commit | 728990a5807882276e34f1f581f70a59f61ba991 (patch) | |
tree | 1d239ea9e01f5d25e15ccef1d43aaea35b3ff27a /docs | |
parent | fbf35c839b706286307b673a3dd6231c81ad4661 (diff) |
start dev readme
Diffstat (limited to 'docs')
-rw-r--r-- | docs/dev/README.md | 37 | ||||
-rw-r--r-- | docs/dev/arhictecture.md (renamed from docs/dev/ARCHITECTURE.md) | 0 |
2 files changed, 37 insertions, 0 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md new file mode 100644 index 000000000..74bf86f68 --- /dev/null +++ b/docs/dev/README.md | |||
@@ -0,0 +1,37 @@ | |||
1 | # Contributing Quick Start | ||
2 | |||
3 | Rust Analyzer is just a usual rust project, which is organized as a Cargo | ||
4 | workspace, builds on stable and doesn't depend on C libraries. So, just | ||
5 | |||
6 | ``` | ||
7 | $ cargo test | ||
8 | ``` | ||
9 | |||
10 | should be enough to get you started! | ||
11 | |||
12 | To learn more about how rust-analyzer works, see | ||
13 | [./architecture.md](./architecture.md) document. | ||
14 | |||
15 | Various organizational and process issues are discussed here. | ||
16 | |||
17 | # Getting in Touch | ||
18 | |||
19 | Rust Analyzer is a part of [RLS-2.0 working | ||
20 | group](https://github.com/rust-lang/compiler-team/tree/6a769c13656c0a6959ebc09e7b1f7c09b86fb9c0/working-groups/rls-2.0). | ||
21 | Discussion happens in this Zulip stream: | ||
22 | |||
23 | https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Fwg-rls-2.2E0 | ||
24 | |||
25 | # Issue Labels | ||
26 | |||
27 | * [good-first-issue](https://github.com/rust-analyzer/rust-analyzer/labels/good%20first%20issue) | ||
28 | are good issues to get into the project. | ||
29 | * [E-mentor](https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3AE-mentor) | ||
30 | issues have links to the code in question and tests. | ||
31 | * [E-easy](https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3AE-easy), | ||
32 | [E-medium](https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3AE-medium), | ||
33 | [E-hard](https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3AE-hard), | ||
34 | labels are *estimates* for how hard would be to write a fix. | ||
35 | * [E-fun](https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3AE-fun) | ||
36 | is for cool, but probably hard stuff. | ||
37 | |||
diff --git a/docs/dev/ARCHITECTURE.md b/docs/dev/arhictecture.md index 57f76ebae..57f76ebae 100644 --- a/docs/dev/ARCHITECTURE.md +++ b/docs/dev/arhictecture.md | |||