Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contrib: Add docs on the rustbot ready command #10916

Merged
merged 1 commit into from
Aug 1, 2022
Merged

Contrib: Add docs on the rustbot ready command #10916

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions src/doc/contrib/src/process/working-on-cargo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,21 @@ typically finish in under 30 minutes.
The reviewer might point out changes deemed necessary. Large or tricky changes
may require several passes of review and changes.

### Status labeling

PRs will get marked with [labels] like [`S-waiting-on-review`] or [`S-waiting-on-author`] to indicate their status.
The [`@rustbot`] bot can be used by anyone to adjust the labels.
If a PR gets marked as `S-waiting-on-author`, and you have pushed new changes that you would like to be reviewed, you can write a comment on the PR with the text `@rustbot ready`.
Comment on lines +127 to +129
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a big deal but these lines are inconsistent in terms of 80 columns convention in this file. Do you wanna update?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some time ago I became a convert to semantic linefeeds. I find that diffs involving text that has been line-wrapped can be difficult to read. Large amounts of the diff are related to the change in line-wrapping and not the actual content. Conversely, if an entire paragraph is not linewrapped, and there is a small change to the text, the diff would show a large change that can be difficult to spot. To combat those issues, semantic linefeeds strike a balance by only line-wrapping on sentences (and sometimes other punctuation like commas). mdBook markdown doesn't care how it is wrapped, and the diffs tend to be easier to view.

For new content I've been writing, I typically switch to semantic linefeeds.
Swapping out the old content can be a hassle, so I normally don't swap it out proactively.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to know that! It seems like a good choice. I'll follow the rule as well.

The bot will switch the labels on the PR.

More information about these commands can be found at the [shortcuts documentation].

[labels]: https://github.com/rust-lang/cargo/labels
[`S-waiting-on-review`]: https://github.com/rust-lang/cargo/labels/S-waiting-on-review
[`S-waiting-on-author`]: https://github.com/rust-lang/cargo/labels/S-waiting-on-author
[`@rustbot`]: https://github.com/rustbot
[shortcuts documentation]: https://github.com/rust-lang/triagebot/wiki/Shortcuts

## The merging process

After a reviewer has approved your PR, they will issue a command to the [bors]
Expand Down