Skip to content

Commit ae61d12

Browse files
committed
Add diagnostics working group
1 parent 13e642e commit ae61d12

File tree

4 files changed

+54
-0
lines changed

4 files changed

+54
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ Name | Status | Short
6161
[Rustc pipelining](working-groups/pipelining/) | Active | Enable Cargo to invoke rustc in a pipelined fashion, speeding up crate graph compiles. | [#t-compiler/wg-pipelining][pipelining-stream]
6262
[Polonius](working-groups/polonius/) | Active | Exploring the integration of the "NLL 2.0"-like ["Polonius analysis"][Polonius] into rustc | [#t-compiler/wg-polonius][polonius_stream]
6363
[Learning](working-groups/learning/) | Active | Make the compiler easier to learn by ensuring that rustc-guide and api docs are "complete" | [#t-compiler/wg-learning][learning_stream]
64+
[Diagnostics](working-groups/diagnostics/) | Active | Use crates.io crates for diagnostics rendering and make emitting diagnostics nicer. | [#t-compiler/wg-diagnostics][diagnostics-stream]
6465

6566
[nikomatsakis]: https://github.com/nikomatsakis
6667
[cramertj]: https://github.com/cramertj
@@ -74,6 +75,7 @@ Name | Status | Short
7475
[Zoxc]: https://github.com/Zoxc
7576
[blitzerr]: https://github.com/blitzerr
7677
[oli-obk]: https://github.com/oli-obk
78+
[estebank]: https://github.com/estebank
7779

7880
[Weekly, in Zulip]: #meeting-calendar
7981
[nll_stream]: https://rust-lang.zulipchat.com/#narrow/stream/122657-t-compiler.2Fwg-nll
@@ -91,6 +93,7 @@ Name | Status | Short
9193
[polonius_stream]: https://rust-lang.zulipchat.com/#narrow/stream/186049-t-compiler.2Fwg-polonius
9294
[learning_stream]: https://rust-lang.zulipchat.com/#narrow/stream/196385-t-compiler.2Fwg-learning
9395
[Polonius]: https://github.com/rust-lang/polonius
96+
[diagnostics-stream]: https://rust-lang.zulipchat.com/#narrow/stream/147480-t-compiler.2Fwg-diagnostics
9497

9598
## Expert Map
9699

working-groups/diagnostics/FAQ.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Frequently Asked Questions (FAQ)
2+
3+
If you have a question, feel free to file an issue or ask in the working group's Zulip stream.
4+
5+
There are no FAQs so far. Please ask us more questions.

working-groups/diagnostics/NOTES.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Diagnostics Meeting Notes
2+
This document will contain meeting notes from the diagnostics working group.
3+

working-groups/diagnostics/README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Diagnostics Working Group
2+
![working group status: active][status]
3+
4+
This working group aims to make rustc better at telling the user why the compiler isn't smart enough
5+
yet to understand their code.
6+
7+
- **Leads:** [@oli-obk][oli-obk] [@estebank][estebank]
8+
- **Meeting Notes:** [All](NOTES.md)
9+
10+
[status]: https://img.shields.io/badge/status-active-brightgreen.svg?style=for-the-badge
11+
12+
## What is the goal of this working group?
13+
This working group aims to accomplish the following:
14+
15+
- Make diagnostics emitting independent of the happy code path
16+
- Separate the diagnostics rendering from the compiler so it can be reused by others.
17+
18+
# How can I get involved?
19+
If you are interested in getting involved in this working group, you should introduce yourself
20+
in the Zulip stream. You can be added to the GitHub and Zulip
21+
group for the working group if you are interested in being pinged when there are available tasks.
22+
23+
- **Desired experience level:** Any
24+
- **Relevant repositories:** [`rust-lang/rust`][repo]
25+
- https://github.com/rust-lang/rust/blob/master/src/libsyntax/json.rs
26+
- https://github.com/rust-lang/rust/tree/master/src/librustc_errors
27+
- https://github.com/rust-lang/rust/tree/master/src/librustc_lint
28+
- https://crates.io/crates/annotate-snippets
29+
- https://crates.io/crates/codemap-diagnostic
30+
- **Zulip stream:** [`#t-compiler/diagnostics`][zulip] on Zulip
31+
32+
[repo]: https://github.com/rust-lang/rust
33+
[zulip]: https://rust-lang.zulipchat.com/#narrow/stream/147480-t-compiler.2Fwg-diagnostics
34+
35+
## What if I don't have much time?
36+
If you don't have time to contribute code, consider setting up meetings and frequently pinging
37+
working group members on related issues to discuss or fix them.
38+
39+
## Are there any resources so I can get up to speed?
40+
Not yet.
41+
42+
## Do I need to attend any meetings?
43+
We don't have any meetings yet.

0 commit comments

Comments
 (0)