Skip to content

Commit 7a80706

Browse files
Merge #9166
9166: Clarify label documentation r=matklad a=flodiebold Also some other cleanups while I'm there. Co-authored-by: Florian Diebold <flodiebold@gmail.com>
2 parents 8b6c3ea + 0290b61 commit 7a80706

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

docs/dev/README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing Quick Start
22

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.
44
So, just
55

66
```
@@ -9,18 +9,18 @@ $ cargo test
99

1010
should be enough to get you started!
1111

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).
1313
It also explains the high-level layout of the source code.
1414
Do skim through that document.
1515

1616
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.
1818

1919
Various organizational and process issues are discussed in this document.
2020

2121
# Getting in Touch
2222

23-
Rust Analyzer is a part of [RLS-2.0 working
23+
rust-analyzer is a part of the [RLS-2.0 working
2424
group](https://github.com/rust-lang/compiler-team/tree/6a769c13656c0a6959ebc09e7b1f7c09b86fb9c0/working-groups/rls-2.0).
2525
Discussion happens in this Zulip stream:
2626

@@ -33,7 +33,7 @@ https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frust-analyzer
3333
* [E-has-instructions](https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3AE-has-instructions)
3434
issues have links to the code in question and tests.
3535
* [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.
3737
* [E-easy](https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3AE-easy),
3838
[E-medium](https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3AE-medium),
3939
[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
4242
* [S-actionable](https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3AS-actionable) and
4343
[S-unactionable](https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3AS-unactionable)
4444
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.
4648
* [fun](https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3Afun)
4749
is for cool, but probably hard stuff.
4850
* [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`
206208
./rust-rust-analyzer # Note the name!
207209
```
208210

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).
210212

211213
`release` calls the GitHub API calls to scrape pull request comments and categorize them in the changelog.
212214
This step uses the `curl` and `jq` applications, which need to be available in `PATH`.

0 commit comments

Comments
 (0)