Skip to content

Commit 2777f6c

Browse files
authored
Add diagnostics working group (#54)
Add diagnostics working group
2 parents 13e642e + 0c43fe3 commit 2777f6c

File tree

6 files changed

+58
-1
lines changed

6 files changed

+58
-1
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

about/triage-meeting.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This section contains the scheduled check-ins for working groups:
1919
- **2019-04-18:** [wg-llvm], [wg-async-await],
2020
- **2019-04-25:** [wg-rfc-2229], [wg-self-profile]
2121
- **2019-05-02:** [wg-meta], [wg-rls-2.0]
22-
- **2019-05-09:** [wg-nll]
22+
- **2019-05-09:** [wg-nll], [wg-diagnostics]
2323

2424
Looking for a meeting that isn't listed above? Make a PR and extend the list to include that
2525
meeting.
@@ -43,3 +43,4 @@ This section lists check-ins from triage meetings before the check-in schedule w
4343
[wg-pgo]: ../working-groups/pgo
4444
[wg-mir-opt]: ../working-groups/mir-opt
4545
[wg-pipelining]: ../working-groups/pipelining
46+
[wg-diagnostics]: ../working-groups/diagnostics

procedures/form-new-working-group.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,11 @@ The basic steps to setup a working group are as follows:
103103
listed and a link to their directory in this repository should also be included. See the
104104
traits working group [as an example][team_repo_example]. This will ensure that the working groups
105105
are listed on the website.
106+
- Add a check-in for your working group to the [compiler-team meeting check-in list](check_in)
106107

107108
[team_repo]: https://github.com/rust-lang/team
108109
[team_repo_example]: https://github.com/rust-lang/team/blob/master/teams/wg-traits.toml
109110

111+
[check_in]: ../about/triage-meeting.md
110112
[README]: ../README.md
111113
[template]: ../working-groups/.template

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
5+
why the compiler isn’t smart enough to understand their code yet.
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)