1
1
# Contributing Quick Start
2
2
3
- Rust Analyzer is an ordinary Rust project, which is organized as a Cargo workspace, builds on stable and doesn't depend on C libraries.
3
+ rust-analyzer is an ordinary Rust project, which is organized as a Cargo workspace, builds on stable and doesn't depend on C libraries.
4
4
So, just
5
5
6
6
```
@@ -9,18 +9,18 @@ $ cargo test
9
9
10
10
should be enough to get you started!
11
11
12
- To learn more about how rust-analyzer works, see [ ./architecture.md] ( ./architecture.md ) document .
12
+ To learn more about how rust-analyzer works, see [ ./architecture.md] ( ./architecture.md ) .
13
13
It also explains the high-level layout of the source code.
14
14
Do skim through that document.
15
15
16
16
We also publish rustdoc docs to pages: https://rust-analyzer.github.io/rust-analyzer/ide/ .
17
- Note though, that internal documentation is very incomplete.
17
+ Note though, that the internal documentation is very incomplete.
18
18
19
19
Various organizational and process issues are discussed in this document.
20
20
21
21
# Getting in Touch
22
22
23
- Rust Analyzer is a part of [ RLS-2.0 working
23
+ rust-analyzer is a part of the [ RLS-2.0 working
24
24
group] ( https://github.com/rust-lang/compiler-team/tree/6a769c13656c0a6959ebc09e7b1f7c09b86fb9c0/working-groups/rls-2.0 ) .
25
25
Discussion happens in this Zulip stream:
26
26
@@ -33,7 +33,7 @@ https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frust-analyzer
33
33
* [ E-has-instructions] ( https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3AE-has-instructions )
34
34
issues have links to the code in question and tests.
35
35
* [ Broken Window] ( https://github.com/rust-analyzer/rust-analyzer/issues?q=is:issue+is:open+label:%22Broken+Window%22 )
36
- are issues which are not critical by themselves, but which should be fixed ASAP regardless, to avoid accumulation of technical debt.
36
+ are issues which are not necessarily critical by themselves, but which should be fixed ASAP regardless, to avoid accumulation of technical debt.
37
37
* [ E-easy] ( https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3AE-easy ) ,
38
38
[ E-medium] ( https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3AE-medium ) ,
39
39
[ E-hard] ( https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3AE-hard ) ,
@@ -42,7 +42,9 @@ https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frust-analyzer
42
42
* [ S-actionable] ( https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3AS-actionable ) and
43
43
[ S-unactionable] ( https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3AS-unactionable )
44
44
specify if there are concrete steps to resolve or advance an issue. Roughly, actionable issues need only work to be fixed,
45
- while unactionable ones are effectively wont-fix. Each triaged issue should have one of these labels.
45
+ while unactionable ones are blocked either on user feedback (providing a reproducible example), or on larger architectural
46
+ work or decisions. This classification is descriptive, not prescriptive, and might be wrong: Any unactionable issue might have a simple fix that we missed.
47
+ Each triaged issue should have one of these labels.
46
48
* [ fun] ( https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3Afun )
47
49
is for cool, but probably hard stuff.
48
50
* [ Design] ( https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%Design )
@@ -206,7 +208,7 @@ Release process is handled by `release`, `dist` and `promote` xtasks, `release`
206
208
./rust-rust-analyzer # Note the name!
207
209
```
208
210
209
- Additionally, it assumes that remote for ` rust-analyzer ` is called ` upstream ` (I use ` origin ` to point to my fork).
211
+ Additionally, it assumes that the remote for ` rust-analyzer ` is called ` upstream ` (I use ` origin ` to point to my fork).
210
212
211
213
` release ` calls the GitHub API calls to scrape pull request comments and categorize them in the changelog.
212
214
This step uses the ` curl ` and ` jq ` applications, which need to be available in ` PATH ` .
0 commit comments