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.

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

Tweak and update subsection Labels of Issue Triaging #744

Merged
merged 1 commit into from
May 15, 2024

Conversation

fmease
Copy link
Member

@fmease fmease commented May 13, 2024

  1. Mention more label categories that are of importance
    1. Mention PG-* labels (→ specific project groups).
    2. Mention L-* labels (→ specific lints).
    3. Mention -Z* labels (→ specific unstable -Z compiler flags).
  2. Mark keywords bold / strong. With keyword I mean words (e.g., team) whose initial is used as the prefix of a label category (e.g., T-). https://rustc-dev-guide.rust-lang.org/contributing.html#issue-triage does this, too, which I found out after the fact.
  3. Linkify label categories just like https://rustc-dev-guide.rust-lang.org/contributing.html#issue-triage.
  4. Add three footnotes for "trivia" (can be used to form mnemonics :P).
  5. Link to https://rustc-dev-guide.rust-lang.org/contributing.html#issue-triage.
  6. Tiny style tweaks for consistency (periods, etc.).
  7. Sort the list of important I-* labels by ... importance and add a two or three more labels.

NB: I haven't added a bullet point for the B-* labels (used on tracking issues & related to unstable language features) because they're not relevant for your everyday issue triaging in my opinion.

@fmease fmease requested a review from Noratrieb May 13, 2024 16:56
@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 13, 2024
@fmease fmease assigned Noratrieb and jieyouxu and unassigned pietroalbini May 13, 2024
@fmease fmease requested a review from jieyouxu May 13, 2024 16:57
@rust-lang rust-lang deleted a comment from rustbot May 13, 2024
Copy link
Member

@jieyouxu jieyouxu left a comment

Choose a reason for hiding this comment

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

Left some nits, but LGTM otherwise.

src/release/issue-triaging.md Show resolved Hide resolved
src/release/issue-triaging.md Outdated Show resolved Hide resolved
src/release/issue-triaging.md Outdated Show resolved Hide resolved
src/release/issue-triaging.md Show resolved Hide resolved
@apiraino
Copy link
Contributor

I've tried looking at the rendered version and to be honest in the new proposed version there's so much formatting that I find it hard to visually parse the document.

Old version

New version

I can't pinpoint exactly all the small things that imo make the new version less readable, they are mixed with small improvements in the wording, which I find otherwise valuable.

I don't have time or energy (or UI skills) to make a detailed review so I won't oppose merging this as it is. I wish we had someone with some a11y background for an informed opinion.

Sorry @fmease I am a minimalist 😆

@jieyouxu
Copy link
Member

I can't pinpoint exactly all the small things that imo make the new version less readable, they are mixed with small improvements in the wording, which I find otherwise valuable.

It's probably a mix of the label prefixs in different font, color and background + bolded keywords + monospace example labels that makes it a bit visually busy. Not sure how to make it less overwhelming either.

@fmease
Copy link
Member Author

fmease commented May 13, 2024

I can remove the links and the weight on the keywords again and only keep the wording tweaks. That'd be fine by me

@jieyouxu
Copy link
Member

I can remove the links and the weight on the keywords again and only keep the wording tweaks. That'd be fine by me

I think it's nice fuctionally to have them lol

@Noratrieb
Copy link
Member

mdbook is less noisy than GitHub, so the comparison isn't entirely fair. I think removing the emphasis makes sense, it's fairly obvious and not that important.

Copy link
Member

@Noratrieb Noratrieb left a comment

Choose a reason for hiding this comment

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

thanks, cool. i'd be fine merging it as-is but if you wanna remove the emphasis and address some more feedback first that works too. just make sure to not get lost in improvements and forget the PR, rather merge early than late :)

@fmease
Copy link
Member Author

fmease commented May 15, 2024

I've addressed the review comments and removed the font weight from the keywords again but kept the links because they're quite useful imo even if they might worsen the UI slightly due to their blue color.

@fmease fmease merged commit dd921e9 into rust-lang:master May 15, 2024
1 check passed
@fmease fmease deleted the tweak-issue-triaging branch May 15, 2024 19:40
fmease added a commit to fmease/rust that referenced this pull request May 15, 2024
… r=jieyouxu

Meta: Allow unauthenticated users to modify `L-*`, `PG-*` and `-Z*` labels

Complements: rust-lang/rust-forge#744.

1. `L-*`: Issues and PRs concerning specific lints
2. `PG-*`: Issues and PRs concerning specific project groups
3. `-Z*`: Issues and PRs concerning specific unstable `-Z` compiler options

These are safe to expose. Allows unauthenticated users greater leeway in triaging issues.
We have a lot of such people <3 and I want to support them as much as possible.

r? jieyouxu (you get assigned a lot these days :P) or compiler
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request May 15, 2024
Rollup merge of rust-lang#125159 - fmease:allow-unauth-labels-l-pg-z, r=jieyouxu

Meta: Allow unauthenticated users to modify `L-*`, `PG-*` and `-Z*` labels

Complements: rust-lang/rust-forge#744.

1. `L-*`: Issues and PRs concerning specific lints
2. `PG-*`: Issues and PRs concerning specific project groups
3. `-Z*`: Issues and PRs concerning specific unstable `-Z` compiler options

These are safe to expose. Allows unauthenticated users greater leeway in triaging issues.
We have a lot of such people <3 and I want to support them as much as possible.

r? jieyouxu (you get assigned a lot these days :P) or compiler
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants