docs: update CONTRIBUTING.md with guidelines-bot details and review expectations #331

PLeVasseur · 2025-12-18T02:49:10Z

No description provided.

…xpectations

netlify · 2025-12-18T02:49:21Z

✅ Deploy Preview for scrc-coding-guidelines ready!

Name	Link
🔨 Latest commit	`0237645`
🔍 Latest deploy log	https://app.netlify.com/projects/scrc-coding-guidelines/deploys/69436ba8ba2ea10009c0a57b
😎 Deploy Preview	https://deploy-preview-331--scrc-coding-guidelines.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

iglesias · 2025-12-20T06:59:28Z

Looks like a handy utility, nice!

felix91gr · 2026-01-06T21:36:09Z

Okay, I'm back now so I should be able to review this soon :)

felix91gr

This is a very shallow preliminary review.

I feel like the bot is well-documented, but I have the hunch that perhaps it could be more clearly presented. I'm going to try a couple of things, will get back to you asap!

felix91gr · 2026-01-06T22:28:14Z

CONTRIBUTING.md


 Within 14 days of your submission, a member of the Coding Guidelines Subcommittee should give you a first review. You'll work with them (and other members) to flesh out the concept and ensure the guideline is well prepared for a Pull Request.

+> **Note:** A reviewer is automatically assigned from the pool of Producers using a round-robin system. See [Reviewer Bot Commands](#reviewer-bot-commands) for details.


We might want to clarify what we mean by a round-robin system.

I think I know what we mean here... something like this, perhaps?

The unassigned producers are put in a queue,

When a review is complete, its producer (reviewer) is put back at the end of the queue,

And all of this results in what is effectively a complete and unbiased rotation of the producer group until any given producer is assigned to review once again.

Did I get it right?

If so, what happens if the queue is empty (because every producer is either on break or reviewing) and a new guideline proposal is opened?

felix91gr · 2026-01-06T22:29:27Z

CONTRIBUTING.md

+
+The reviewer bot (`@guidelines-bot`) automatically assigns reviewers to coding guideline issues and PRs using a round-robin system. Only members marked as "Producer" in the consortium's `subcommittee/coding-guidelines/members.md` are included in the rotation.
+
+The queue state is stored in [Issue #314](https://github.com/rustfoundation/safety-critical-rust-coding-guidelines/issues/314).


Suggested change

The queue state is stored in [Issue #314](https://github.com/rustfoundation/safety-critical-rust-coding-guidelines/issues/314).

The queue's state is stored in [Issue #314](https://github.com/rustfoundation/safety-critical-rust-coding-guidelines/issues/314).

I'm 98% sure this goes like that.

felix91gr · 2026-01-09T19:52:37Z

Okay, this is sort of what I had in mind for the ## Reviewer Bot Commands section.

Lemme know how it looks to you, @PLeVasseur?

PS: for some reason, > [!NOTE] doesn't render inside of <details>. This is how it's supposed to look like:

Note

These commands only apply in the context of coding guideline issues.

(warning: wall of text!)

Reviewer Bot Commands

[!NOTE]
These commands only apply in the context of coding guideline issues.

Before we continue, here's a preamble on how the reviewer bot helps reviewers do their job.

The reviewer bot (guidelines-bot) automatically assigns reviewers to coding guideline issues and PRs using a round-robin system.
Only members marked as "Producer" in the consortium's members.md are included in the rotation.
The queue's state is stored in Issue #314.
All commands are invoked by mentioning @guidelines-bot in a comment

Down below are the available commands.

Pass this Review to the next Producer

Format

@guidelines-bot /pass [reason (optional)]

When to use it

You may use this if you were assigned as reviewer for a specific issue / PR.

Use it when you cannot review it in particular, but want to remain in the rotation for future assignments.

Result

The next reviewer in the queue will be assigned instead.

You will return to the queue for future assignments.

Example

@guidelines-bot /pass Not familiar enough with FFI to review this one

Temporarily Exit the Review Queue

Format

@guidelines-bot /away YYYY-MM-DD [reason (optional)]

When to use it

You may use this if you are a producer who's currently in the rotation.

Use it if you unable to do reviews until some date in the future.

Result

You will be removed from the review queue until the specified date.

If you're currently assigned to an issue / PR, the next reviewer will be assigned in your place.

You'll be automatically added back when the date arrives.

Example

@guidelines-bot /away 2025-02-15 On vacation

Claim Review of this Issue / PR

Format

@guidelines-bot /claim

When to use it

You may use this if you are a producer who's currently in the rotation.

Use it if you want to proactively claim the review duty of an issue / PR.

Ask for permission if the existing reviewer has been working on it already.

Result

You will be assigned as the reviewer for this issue / PR.

Any existing review assignment to it will be removed.

Example

@guidelines-bot /claim

Release your Assignment from this Issue / PR

Format

@guidelines-bot /release [reason]

When to use it

You would like to use /pass, but you would prefer to leave the issue / PR without an assigned reviewer.

Prefer to use /pass unless you have a reason to leave this unassigned.

Result

The issue / PR will be left unassigned.

You will return to the queue for future assignments.

Example

@guidelines-bot /release Need to focus on other priorities

Assign a Specific Reviewer

Format

@guidelines-bot /r? @username

When to use it

You are a producer, and you know someone with specific expertise that may be a good fit for reviewing this guideline.

Ask for permission if the existing reviewer has been working on it already.

Result

The same result as if the specified reviewer had used /claim on the issue / PR.

Namely, the existing reviewer will be returned to the queue and the specified reviewer will be assigned to the issue / PR instead.

Example

@guidelines-bot /r? @expert-reviewer

Request Next Reviewer from Queue

Format

@guidelines-bot /r? producers

When to use it

You're a producer, and one of the following is true:

This issue / PR was opened without the coding guideline label, and thus was not assigned a reviewer.
It had a reviewer in the past but no longer, and you want it to get a new one.
Or for other reasons, you want to explicitly trigger the round-robin assignment

Result

If the Issue / PR had a reviewer, this works as if the reviewer had run /pass.

If it didn't, this picks a new reviewer by triggering the round-robin assignment.

Example

@guidelines-bot /r? producers

Other Commands

Manage Labels

Adding a label:

@guidelines-bot /label +label-name

Removing a label:

@guidelines-bot /label -label-name

Sync Members

Manually trigger a sync of the reviewer queue with members.md. This happens automatically on each workflow run, but you can force it if needed.

@guidelines-bot /sync-members

Check Queue Status

Shows the current queue position, who's next up for review, and who is currently away.

@guidelines-bot /queue

Show Available Commands

Shows all available bot commands with descriptions.

@guidelines-bot /commands

github-actions · 2026-01-09T19:52:54Z

✅ @AlexCeleste has passed this review. Reason: [reason (optional)]

@jmqd is now assigned as the reviewer.

@AlexCeleste is next in queue for future issues.

felix91gr · 2026-01-09T19:54:37Z

AHHHH the bot reacted to the command goes here code blocks??

Sorry about that. That's... a bug, I think. Anywho, it was not my intention. I'll clean this up. Sorry about the ping, @jmqd

felix91gr · 2026-01-09T19:55:28Z

@guidelines-bot /r? @AlexCeleste

github-actions · 2026-01-09T19:55:57Z

✅ @AlexCeleste has been assigned as reviewer.

docs: update CONTRIBUTING.md with guidelines-bot details and review e…

0237645

…xpectations

PLeVasseur requested review from AlexCeleste and felix91gr December 18, 2025 02:49

PLeVasseur added the contributor experience Related to making contributions easier label Dec 18, 2025

github-project-automation bot added this to [Safety Critical Rust Consortium Coding Guidelines] Work Items Dec 18, 2025

felix91gr reviewed Jan 6, 2026

View reviewed changes

github-actions bot removed the request for review from AlexCeleste January 9, 2026 19:52

github-actions bot requested a review from AlexCeleste January 9, 2026 19:55

felix91gr mentioned this pull request Jan 9, 2026

[Guidelines-Bot] The bot might be too eager, we should probably fix that. #362

Open


		Within 14 days of your submission, a member of the Coding Guidelines Subcommittee should give you a first review. You'll work with them (and other members) to flesh out the concept and ensure the guideline is well prepared for a Pull Request.

		> Note: A reviewer is automatically assigned from the pool of Producers using a round-robin system. See [Reviewer Bot Commands](#reviewer-bot-commands) for details.


		The reviewer bot (`@guidelines-bot`) automatically assigns reviewers to coding guideline issues and PRs using a round-robin system. Only members marked as "Producer" in the consortium's `subcommittee/coding-guidelines/members.md` are included in the rotation.

		The queue state is stored in [Issue #314](https://github.com/rustfoundation/safety-critical-rust-coding-guidelines/issues/314).

	The queue state is stored in [Issue #314](https://github.com/rustfoundation/safety-critical-rust-coding-guidelines/issues/314).
	The queue's state is stored in [Issue #314](https://github.com/rustfoundation/safety-critical-rust-coding-guidelines/issues/314).

docs: update CONTRIBUTING.md with guidelines-bot details and review expectations #331

Are you sure you want to change the base?

docs: update CONTRIBUTING.md with guidelines-bot details and review expectations #331

Conversation

PLeVasseur commented Dec 18, 2025

Uh oh!

netlify bot commented Dec 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for scrc-coding-guidelines ready!

Uh oh!

iglesias commented Dec 20, 2025

Uh oh!

felix91gr commented Jan 6, 2026

Uh oh!

felix91gr left a comment

Choose a reason for hiding this comment

Uh oh!

felix91gr Jan 6, 2026

Choose a reason for hiding this comment

Uh oh!

felix91gr Jan 6, 2026

Choose a reason for hiding this comment

Uh oh!

felix91gr commented Jan 9, 2026

Reviewer Bot Commands

Pass this Review to the next Producer

Format

When to use it

Result

Example

Temporarily Exit the Review Queue

Format

When to use it

Result

Example

Claim Review of this Issue / PR

Format

When to use it

Result

Example

Release your Assignment from this Issue / PR

Format

When to use it

Result

Example

Assign a Specific Reviewer

Format

When to use it

Result

Example

Request Next Reviewer from Queue

Format

When to use it

Result

Example

Other Commands

Manage Labels

Sync Members

Check Queue Status

Show Available Commands

Uh oh!

github-actions bot commented Jan 9, 2026

Uh oh!

felix91gr commented Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

felix91gr commented Jan 9, 2026

Uh oh!

github-actions bot commented Jan 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

netlify bot commented Dec 18, 2025 •

edited

Loading

felix91gr commented Jan 9, 2026 •

edited

Loading