Skip to content

Commit 4a9dd4d

Browse files
authored
Merge pull request #252 from tmandry/patch-1
Update async-await page to point to team repo
2 parents 3873402 + a2ac601 commit 4a9dd4d

File tree

1 file changed

+7
-109
lines changed

1 file changed

+7
-109
lines changed

content/working-groups/async-await/_index.md

+7-109
Original file line numberDiff line numberDiff line change
@@ -8,116 +8,14 @@ type: docs
88
This working group is focused around implementation/design of the "foundations" for Async I/O.
99
This includes the `async-await` language feature but also the core `Future` trait and adapters.
1010

11-
- **Leads:** [@cramertj][cramertj] and [@nikomatsakis][nikomatsakis].
12-
- **Labels:** We use the `AsyncAwait-*` labels on Github to track our work.
13-
See the [How to get involved](#how-to-get-involved) section for details.
14-
- **Zulip stream:** [`#wg-async-foundations`][stream] on Zulip
15-
- **Videos:** Video meetings and mentoring sessions are recorded and posted to this [YouTube playlist](https://www.youtube.com/watch?v=xe2_whJWBC0&list=PL85XCvVPmGQgGNOAwhOKIfCL6TuRLJlWy).
11+
- **Leads:** [@tmandry][tmandry] and [@nikomatsakis][nikomatsakis].
12+
- **Zulip stream:** [#wg-async-foundations][zulip] on Zulip
1613

17-
[repo]: https://github.com/rust-lang/rust
14+
**See the [wg-async-foundations repo][repo] for more information and how to get involved.**
15+
16+
[repo]: https://github.com/rust-lang/wg-async-foundations
17+
[zulip]: https://rust-lang.zulipchat.com/#narrow/stream/187312-wg-async-foundations
1818
[nikomatsakis]: https://github.com/nikomatsakis
19-
[cramertj]: https://github.com/cramertj
19+
[tmandry]: https://github.com/tmandry
2020

2121
[status]: https://img.shields.io/badge/status-active-brightgreen.svg?style=for-the-badge
22-
23-
## What is the goal of this working group?
24-
25-
### Current focus
26-
27-
The **current focus** of the group is polishing the async-await
28-
feature and working on the async book.
29-
30-
### Overall roadmap and progress
31-
32-
- ✅ Stabilize the `Future` trait
33-
- ✅ Deliver a "minimal viable product" (MVP) introducing `async fn` inherent functions and async blocks.
34-
- ⚒️ Polish the async-await feature, improving diagnostics, spurious errors, and other corner cases.
35-
- ⚒️ Write the [async book](https://github.com/rust-lang/async-book), which introduces how the core language features in support of Async I/O and teaches you how to use them.
36-
37-
### Future areas
38-
39-
Possible future areas for consideration include:
40-
41-
- Stabilize other core traits in std, such as `AsyncRead`
42-
- Support async fn in traits
43-
- Support async closures (and possibly an `AsyncFn` trait)
44-
- Support consuming async streams conveniently (e.g., `for await` loops or some similar thing)
45-
- Support authoring async streams conveniently via async generators
46-
- Support async drop
47-
48-
However, we've decided to largely defer this sort of work until we've
49-
finished off more of the polish work on async-await.
50-
51-
## How to get involved
52-
53-
We are currently working to systematically polish the `async-await`
54-
feature. If you'd like to get involved, take a look at the list of
55-
[focus issues](#focus-issues) to see if there is one there is
56-
something unassigned that you would like to work on. Otherwise, drop
57-
in on the [Zulip stream][stream] and say hi, or come to our [triage
58-
meeting](#triage-meeting) (also held on Zulip).
59-
60-
You can also help just by [**nominating issues**](#nominating-issues) -- i.e., telling us
61-
which issues you think are more important to fix and why.
62-
63-
### Focus issues
64-
65-
We always have a set of "focus issues", which are the ones that we are either
66-
actively fixing or looking for someone to fix. In general, we track our issues
67-
using a set of ethre labels:
68-
69-
- [AsyncAwait-Triaged] -- the base label, which indicates issues that
70-
we've looked at in our meetings. Each meeting we look for [untriaged
71-
issues], which are those that are labeled `A-async-await` but which
72-
lack the `AsyncAwait-Triaged` label, and try to keep track of them.
73-
**To ensure new issues are known to all, this label should only be
74-
added during WG triage meetings!**
75-
- [AsyncAwait-OnDeck] -- this label is added to issues that we might
76-
focus on next. You can [nominate issues](#nominating-issues)
77-
yourself to add them to this list, if you like! We typically pick
78-
from this list when a focus issue is closed or gets stalled.
79-
- [AsyncAwait-Focus] -- this label indicates a current focus issue.
80-
These issues are typically assigned, but if they are not, it means
81-
we'd like someone to pick it up.
82-
83-
[AsyncAwait-Focus]: https://github.com/search?q=org%3Arust-lang+is%3Aissue+label%3AAsyncAwait-Focus+is%3Aopen&type=Issues
84-
[AsyncAwait-OnDeck]: https://github.com/search?q=org%3Arust-lang+is%3Aissue+label%3AAsyncAwait-OnDeck+is%3Aopen&type=Issues
85-
[AsyncAwait-Triaged]: https://github.com/search?q=org%3Arust-lang+is%3Aissue+label%3AAsyncAwait-Triaged+is%3Aopen&type=Issues
86-
87-
### Nominating issues
88-
89-
If you think an issue would be a good choice to fix sooner rather than
90-
later, you can **nominate** it for us. To do so, you need to leave a
91-
comment which adds the `AsyncAwait-OnDeck` label. The comment should
92-
also explain **why** you think this is important.
93-
94-
Here is an example of such a comment:
95-
96-
```
97-
@rustbot modify labels to +AsyncAwait-OnDeck
98-
99-
This issue would be great to fix! I hit it pretty regularly
100-
and every time I am left scratching my head for five minutes
101-
before I figure out the problem.
102-
```
103-
104-
### Triage meeting
105-
106-
We have a [short triage meeting every week][event], which you can find
107-
on the [compiler calendar][cc]. The meeting is help on [the
108-
`#wg-async-foundations` Zulip stream][stream] and is open to all. The
109-
meeting agenda is as follows:
110-
111-
- Review [uncategorized issues], assigning a `AsyncAwait-*` label
112-
- Review [AsyncAwait-Focus] issues to check we are making progress
113-
- Promote issues from [AsyncAwait-OnDeck] to [AsyncAwait-Focus] as needed
114-
- Promote issues from [AsyncAwait-Other] to [AsyncAwait-OnDeck] as needed
115-
116-
[uncategorized issues]: https://github.com/search?q=org%3Arust-lang+is%3Aissue+label%3AA-async-await+is%3Aopen+-label%3AAsyncAwait-Triaged&type=Issues
117-
[A-async-await]: https://github.com/search?q=org%3Arust-lang+is%3Aissue+label%3AA-async-await+is%3Aopen&type=Issues
118-
119-
[event]: https://rust-lang.zulipchat.com/#narrow/stream/187312-wg-async-foundations
120-
[cc]: ../../#meeting-calendar
121-
[stream]: https://rust-lang.zulipchat.com/#narrow/stream/187312-wg-async-foundations
122-
[z]: https://rust-lang.zulipchat.com
123-

0 commit comments

Comments
 (0)