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

feat: Demarcate bot raised PRs #36

Merged
merged 2 commits into from
Oct 23, 2024
Merged

feat: Demarcate bot raised PRs #36

merged 2 commits into from
Oct 23, 2024

Conversation

akash1810
Copy link
Member

@akash1810 akash1810 commented Oct 23, 2024

What does this change?

On the assumption that PRs raised by a human should be prioritised, add a prefix to bot raised PRs to provide a visual difference between the two. Also add the PR author to the message.

Alternative solution

An alternative to this would be to group bot PRs together. This would then allow a summary to be provided too, for example:

🧵 Wednesday Reviews 🧵
(PR's can be hidden from this bot by adding the Stale tag)

Total PRs: 10 (7 raised by bots)

However, this would require more of a refactor.

How to test

Follow the instructions in the README to run locally.

How can we measure success?

PRs raised from colleagues are triaged faster. NOTE: I've not got any metrics to suggest this is actually a problem, just anecdotal experience.

Have we considered potential risks?

Are the messages too noisy?

Images

Before

image

After

image

On the assumption that PRs raised by a human should be prioritised,
add a prefix to bot raised PRs to provide a visual difference between the two.

Also add the PR author to the message.
Copy link

@emdash-ie emdash-ie left a comment

Choose a reason for hiding this comment

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

I like it! But I have never been on a team that uses actions-prnouncer, so maybe take my approval with a grain of salt.

Copy link
Member

@AshCorr AshCorr left a comment

Choose a reason for hiding this comment

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

I'd be a fan of both approaches at the same time!

src/main.rs Outdated Show resolved Hide resolved
@akash1810 akash1810 merged commit ffc4f08 into main Oct 23, 2024
8 checks passed
@akash1810 akash1810 deleted the aa/add-username branch October 23, 2024 11:15
akash1810 added a commit that referenced this pull request Oct 23, 2024
Following on from #36, this change keeps the message structure more uniform.
This should mean the messages are slightly easier to visually parse.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants