Skip to content

Commit 6e232c4

Browse files
committed
Add documentation for tracking PRs assigned for review through the Zulip chat
1 parent 4d81d63 commit 6e232c4

File tree

3 files changed

+27
-0
lines changed

3 files changed

+27
-0
lines changed

Diff for: src/SUMMARY.md

+1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
- [Agenda Generator](./triagebot/agenda.md)
1515
- [Issue Assignment](./triagebot/issue-assignment.md)
1616
- [PR Assignment](./triagebot/pr-assignment.md)
17+
- [Tracking PR assignment](./triagebot/pr-assignment-tracking.md)
1718
- [Autolabels](./triagebot/autolabels.md)
1819
- [Close](./triagebot/close.md)
1920
- [Documentation Updates](./triagebot/doc-updates.md)

Diff for: src/triagebot/pr-assignment-tracking.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Tracking PR assignment
2+
3+
If you contribute in some capacity to the Rust compiler development, you might also be assigned pull requests to be reviewed.
4+
5+
You can check your current review assignment in two ways:
6+
- by visiting this [GitHub URL](https://github.com/pulls/assigned)
7+
- by interacting with the `@triagebot` on the [Zulip chat](/platforms/zulip.md) in a DM (Direct Messages) thread. You can open a direct message session clicking on [this link](https://rust-lang.zulipchat.com/#narrow/dm/261224-triagebot) (requires Zulip login).
8+
9+
This chapter will describe how to interact with the bot on Zulip.
10+
11+
## Configuration
12+
13+
Tracking the PR assignment is enabled on the git repository by having a `[pr-tracking]` table in `triagebot.toml`. No additional configuration is needed.
14+
15+
## Usage
16+
17+
Open a Direct Message sessioj with the `triagebot` and use one of these commands:
18+
19+
* `work` --- Will emit an error and show the available commands
20+
* `work show` --- Will show your Github username and a list of pull requests assigned to you for review (on the `rust-lang/rust` git repository)
21+
22+
## Implementation
23+
24+
See [`parser/src/handlers/pr_tracking.rs`](https://github.com/rust-lang/triagebot/blob/HEAD/parser/handlers/pr_tracking.rs).

Diff for: src/triagebot/pr-assignment.md

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
Triagebot handles automatic and manual assignment of GitHub PRs.
44
It also handles welcoming new users when they post a PR.
55

6+
Rust contributors can track and manage their own work queue using the Zulipchat integration. See [Tracking PR assignment](/triagebot/pr-assignment-tracking.md).
7+
68
## Usage
79

810
Automatic assignment of new PRs is handled by the configuration in the `triagebot.toml`, described [below](#configuration).

0 commit comments

Comments
 (0)