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

Proposal: improving review process with bot-assisted checkboxes #1007

Open
moul opened this issue Jul 31, 2023 · 3 comments
Open

Proposal: improving review process with bot-assisted checkboxes #1007

moul opened this issue Jul 31, 2023 · 3 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@moul
Copy link
Member

moul commented Jul 31, 2023

We've been mulling over boosting our review process (#998, #985, #1005, and more).

Here's what I'm thinking:

  1. We kick-off with a comment sporting a checkbox and easy-peasy instructions. A bot gets to tick this when the contributor's nailed all tasks, or a reviewer steps in to give it a nod.
  2. We keep a CI/CD check yellow - a signal we're on standby, not in error mode - until the checkbox gets a tick.
  3. Bonus: this special comment can be updated by the bot to give straightforward specific instructions.

This ensures that either the contributor's done their bit, or a reviewer's given it a thumbs up.

There's good stuff happening over at https://github.com/snyk/release-notes-preview - they're using a similar system for making commit messages chime with automatic changelog and releases.

Later on, our bot could step up - like ensuring devs have signed off on a DCO, or handling specific directives for crucial repo folders. For this, I'd go with a CI/CD reacting to PR changes, and invoking a homemade Go script we could nestle in misc/gh-action.

What do you think? Let's chew the fat over this.

@moul moul added good first issue Good for newcomers help wanted Extra attention is needed labels Jul 31, 2023
@moul moul changed the title Proposal: Improving Review Process with Bot-Assisted Checkboxes Proposal: improving review process with bot-assisted checkboxes Jul 31, 2023
@moul
Copy link
Member Author

moul commented Jul 31, 2023

@moul
Copy link
Member Author

moul commented Jul 31, 2023

Update:

Changed settings to Title and description from Title and commit messages.

Realized the extension "refined github" already handles improvements: Read more.

We can maintain the current setup and explore configuring "refined github" to omit checkboxes while preserving other elements.

@ajnavarro
Copy link
Contributor

@moul a super simple required checked checker: https://github.com/marketplace/actions/require-checklist

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
Status: Todo
Status: 🔵 Not Needed for Launch
Development

No branches or pull requests

2 participants