Skip to content

Add rustdoc team processes #852

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

Merged
merged 5 commits into from
Aug 5, 2025
Merged

Conversation

GuillaumeGomez
Copy link
Member

@GuillaumeGomez GuillaumeGomez commented May 21, 2025

cc @rust-lang/rustdoc

Rendered

@ehuss
Copy link
Contributor

ehuss commented May 21, 2025

Can you also add the rustdoc team to triagebot.toml for this directory and give yourselves permissions in https://github.com/rust-lang/team/blob/HEAD/repos/rust-lang/rust-forge.toml?

Copy link
Member

@aDotInTheVoid aDotInTheVoid left a comment

Choose a reason for hiding this comment

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

Thanks for working on this! I'm very happy to see this written down.

@fmease fmease added T-rustdoc Team: Rustdoc needs-fcp This change is insta-stable, so needs a completed FCP to proceed. labels May 21, 2025
@fmease
Copy link
Member

fmease commented May 21, 2025

(This PR will obviously need a T-rustdoc FCP to make it official once most things have been sufficiently fleshed out)

@fmease fmease added the S-waiting-on-team Status: Awaiting review/feedback/decision from relevant team(s) label May 21, 2025
Copy link
Member

@Manishearth Manishearth left a comment

Choose a reason for hiding this comment

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

overall this seems pretty good!

@GuillaumeGomez
Copy link
Member Author

(This PR will obviously need a T-rustdoc FCP to make it official once most things have been sufficiently fleshed out)

Absolutely!

@GuillaumeGomez
Copy link
Member Author

I added the change in triagebot.toml as suggested by @ehuss.

I went through all comments.

@fmease: Hopefully I clarified that the rustdoc "groups" are not full-fledged teams and as such, to be part of them, you need to be a member of the rustdoc team.

Copy link
Contributor

@lolbinarycat lolbinarycat left a comment

Choose a reason for hiding this comment

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

a few nitpicks

Copy link
Contributor

@apiraino apiraino left a comment

Choose a reason for hiding this comment

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

left a comment after a cursory read.

Great work @GuillaumeGomez !

@GuillaumeGomez GuillaumeGomez force-pushed the rustdoc branch 2 times, most recently from 4da4ad9 to ab7ee18 Compare May 22, 2025 12:41
@GuillaumeGomez GuillaumeGomez force-pushed the rustdoc branch 2 times, most recently from e92f236 to cc605f3 Compare May 22, 2025 20:53
Copy link
Member

@camelid camelid left a comment

Choose a reason for hiding this comment

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

Thanks, this looks great! I left a few comments about small clarifications, but the overall charter looks excellent.

@rfcbot
Copy link

rfcbot commented Jul 8, 2025

🔔 This is now entering its final comment period, as per the review above. 🔔

psst @GuillaumeGomez, I wasn't able to add the final-comment-period label, please do so.

@camelid camelid added the final-comment-period Will be merged/postponed/closed in ~10 calendar days unless new substational objections are raised. label Jul 8, 2025
@lolbinarycat
Copy link
Contributor

I think that we should have a section for what happens if you get assigned as a reviewer on a PR that you don't have the time or experience to review properly, such as if it's a large change to a sub-component you haven't worked with before. Having a policy for this would probably be quite helpful for any new team members.

@fmease
Copy link
Member

fmease commented Jul 9, 2025

I think that we should have a section for what happens if you get assigned as a reviewer on a PR that you don't have the time or experience to review properly, such as if it's a large change to a sub-component you haven't worked with before.

This is already covered. See src/rustdoc/reviews.md:

Review Policy

The rustdoc team follows the same review policy as the compiler team. Take a look at
their chapter about it.

which delegates to compiler/reviews.md which in turn states (excerpts):

Basic Reviewing Requirements

There are a number of requirements that need to be met in order for reviewing to
be effective:

  • Reviewers must have a sufficient understanding of the code under review.
    […]
  • Reviewers must have a good idea on whether they are the right person to approve the change.
    […]

(see linked documents for more details)

@rfcbot
Copy link

rfcbot commented Jul 18, 2025

The final comment period, with a disposition to merge, as per the review above, is now complete.

As the automated representative of the governance process, I would like to thank the author for their work and everyone else who contributed.

This will be merged soon.

psst @GuillaumeGomez, I wasn't able to add the finished-final-comment-period label, please do so.

@fmease fmease added finished-final-comment-period The final comment period is finished for this RFC. disposition-merge This RFC is in PFCP or FCP with a disposition to merge it. labels Jul 18, 2025
@GuillaumeGomez
Copy link
Member Author

Need approval from @apiraino and @notriddle since they requested changes to be able to merge. :)

Copy link
Contributor

@apiraino apiraino left a comment

Choose a reason for hiding this comment

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

left 2 nits but otherwise LGTM 👍

Copy link
Contributor

@apiraino apiraino left a comment

Choose a reason for hiding this comment

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

:rocket: emoji for me

@notriddle
Copy link
Contributor

👍

@fmease
Copy link
Member

fmease commented Aug 4, 2025

The GH interface tells me that merging is still blocked because all comments must be resolved first.

I've therefore gone through all unresolved comments and checked if they've been addressed and if so marked them as resolved.

There's now a single comment left to be addressed, namely #852 (comment). It's only a minor issue that is relatively easy to resolve. Once that's done we can merge this :)

@fmease fmease merged commit 57efdc9 into rust-lang:master Aug 5, 2025
1 check passed
@rustbot rustbot removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 5, 2025
@GuillaumeGomez GuillaumeGomez deleted the rustdoc branch August 5, 2025 12:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
disposition-merge This RFC is in PFCP or FCP with a disposition to merge it. final-comment-period Will be merged/postponed/closed in ~10 calendar days unless new substational objections are raised. finished-final-comment-period The final comment period is finished for this RFC. needs-fcp This change is insta-stable, so needs a completed FCP to proceed. S-waiting-on-team Status: Awaiting review/feedback/decision from relevant team(s) T-rustdoc Team: Rustdoc
Projects
None yet
Development

Successfully merging this pull request may close these issues.