Skip to content

Commit

Permalink
Merge pull request #729 from apiraino/add-pr-tracking-zulip-docs
Browse files Browse the repository at this point in the history
Add docs for tracking PRs assigned for review through the Zulip chat
  • Loading branch information
jackh726 committed Mar 12, 2024
2 parents 4d81d63 + b04830f commit 54c62bb
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
- [Agenda Generator](./triagebot/agenda.md)
- [Issue Assignment](./triagebot/issue-assignment.md)
- [PR Assignment](./triagebot/pr-assignment.md)
- [Tracking PR assignment](./triagebot/pr-assignment-tracking.md)
- [Autolabels](./triagebot/autolabels.md)
- [Close](./triagebot/close.md)
- [Documentation Updates](./triagebot/doc-updates.md)
Expand Down
24 changes: 24 additions & 0 deletions src/triagebot/pr-assignment-tracking.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Tracking PR assignment

If you contribute in some capacity to the Rust compiler development, you might also be assigned pull requests to be reviewed.

You can check your current review assignment in two ways:
- by visiting this [GitHub URL](https://github.com/pulls/assigned)
- 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 with the `triagebot` clicking on [this link](https://rust-lang.zulipchat.com/#narrow/dm/261224-triagebot) (requires Zulip login).

This chapter will describe how to interact with the `triagebot` on Zulip.

## Configuration

Tracking the PR assignment is enabled on the git repository by having a `[pr-tracking]` table in `triagebot.toml`. No additional configuration is needed.

## Usage

Open a Direct Message session with the `triagebot` and send a message with one of these commands:

* `work` --- Will emit an error and show the available commands
* `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)

## Implementation

See [`parser/src/handlers/pr_tracking.rs`](https://github.com/rust-lang/triagebot/blob/HEAD/parser/handlers/pr_tracking.rs).
2 changes: 2 additions & 0 deletions src/triagebot/pr-assignment.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
Triagebot handles automatic and manual assignment of GitHub PRs.
It also handles welcoming new users when they post a PR.

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

## Usage

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

0 comments on commit 54c62bb

Please sign in to comment.