docs: update CONTRIBUTING.md with guidelines-bot details and review expectations #331
Conversation
PLeVasseur
added
the
contributor experience
✅ Deploy Preview for scrc-coding-guidelines ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Looks like a handy utility, nice! |
|
Okay, I'm back now so I should be able to review this soon :) |
felix91gr
left a comment
felix91gr
left a comment
There was a problem hiding this comment.
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!
|
|
||
| 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. |
There was a problem hiding this comment.
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?
|
|
||
| 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). |
There was a problem hiding this comment.
| 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.
3 participants
No description provided.