fwouts / prmonitor

A browser extension to keep track of incoming and outgoing PRs

PR Monitor

Note Looking for new maintainer

PR Monitor is stable, no new features are planned and it's in maintenance only.

If you'd like to improve it further, please send a pull request or feel free to fork the project.

PR Monitor is a Chrome and Firefox extension that helps you keep track of incoming and outgoing PRs, and notifies you when you receive a pull request on GitHub.

What does it look like?

Here's a quick demo of PR Monitor in action:

GIF made with Gifski 2

How to install

1. Install the Chrome extension or Firefox extension
2. Create a GitHub personal access token with the repo permission
3. Enter the token into the extension
4. Enjoy

Using PR Monitor with GitHub Enterprise

In order to use PR Monitor with GitHub Enterprise, you'll need to download the source code and set the baseUrl to match your GitHub Enterprise API URL, then compile the code (see below).

It's a two-line change, so don't be afraid! Refer to #769 for an example.

How to build it yourself

If you don't trust a random browser extension on the Internet with your GitHub token, that's understandable.

Here's how to build the extension yourself from source:

1. Install Yarn.
2. Install dependencies with yarn install.
3. Run yarn build.
4. In Chrome, go to chrome://extensions and enable "Developer mode" in the top-right corner.
5. Click "Load unpacked" and select the generated dist/ directory.

Feedback

Feel free to file an issue with your feedback.

prmonitor's Issues

Remove verification upon mute of specific PR.

Right now it asks "are you sure?". It's not necessary.

Otherwise, move it to a list of "not yet needed", so there's never a need to pay attention.

Ignore archived repositories

Similar to #65 but since archived repos don't have functioning PRs anyway, better to ignore them outright.

Show a notification if you are tagged in a PR without being a reviewer

This could be a tag in the PR description, or in the text of a comment or review.

Need to possibly also look at review comments to cover all possible cases.

Entire screen flashes when refresh finishes

Mute everything for X hours

If you receive a PR off working hours, you probably shouldn't jump on it right away. By showing notifications, we make it too tempting to look at them. It would be good to be able to set a schedule, and/or snooze for some time.

Improve the setup process

• Automatically prompt for the GitHub API token on install
• Check whether the API token is correct or not immediately
• Immediately show notifications for pull requests

Muting a PR doesn't work the second time

"Error: Failed to fetch" when laptop closed

Allow disabling notifications

By default, PR Monitor shows notifications.

However, heavy GitHub users might not want this. See https://gist.github.com/sindresorhus/36b64d5761f47962ab1869d1d559fe52 for example.

As an addition, it may be good to delay the request for permission to show notifications until the user has entered their GitHub token to lower friction for new installs.

Feature Request: Use same window for PR if one is already open

When opening a PR, see if a tab already exists w/ the same PR open (files/convo view/etc), and focus that instead of opening new windows.

Paginate through repos and pull requests

It's possible to miss notifications if you have a lot of repos or a repo has a lot of pull requests. We should be paginating.

Show PR draft status

Add indicator of whether own PRs are in draft mode.

Ability to ignore specific repositories

You may want PR Monitor to only watch some repositories. For example on my laptop at work, I don't want to see pull requests for my personal projects.

It should be possible to either:

• uncheck specific repositories
• uncheck entire repository owners (e.g. my personal account)
• or maybe the opposite?

PR Monitor ignores GitHub API rate limiting

Clean up the GraphQL request

The GraphQL request we're making to fetch the pull requests assigned to the current user is scandalously large. It would probably make GitHub API engineers very sad.

Show the build status of each PR

Make mute button more discrete

See https://gist.github.com/sindresorhus/36b64d5761f47962ab1869d1d559fe52

Create a Firefox extension as well

Draft PR status not displayed in list of PRs

Having Draft status would be useful to know what PRs to review and not.

Show a visible error (! in the badge) when GitHub API call failed

PR Monitor doesn't show your own PRs on open source projects where you're not a contributor

This is because at the moment PR Monitor loads all repos you are a contributor to, then all of their PRs. We should instead directly ask GitHub for all PRs that you're involved in, using their Search API.

@Kastet FYI

Popup should not say "Nothing to review" when missing token

Keep your own PR as "Approved" even if new commits are posted

"Not found" error when a repo with PRs is deleted

The only workaround seems to be re-installing the extension...

Improve first-use experience

If you use PR Monitor for the first time, you may see a loading spinner for a long while.

It would be useful to explain why this is taking longer than usual, and reassure users that things are going as expected.

Split up background.js into smaller files

We need a proper build process. Time to use Bazel?

Add an "Open all unreviewed PRs" button

If you have 25 PRs to review (e.g. because of dependabot), it gets pretty tiring to open the popup, click on a PR, re-open the popup, click on the next one, etc.

Extract settings into a separate screen

See https://gist.github.com/sindresorhus/36b64d5761f47962ab1869d1d559fe52

Add a README

Show avatar of PR author

Showing the avatar of each PR's author would give valuable visual context.

Show a confirmation when clicking Save

Show repository in PR notification

When I look at the following notification:

I have no way to know what repository this is for.

Show PRs that the user raised, not just PRs received

These should be shown in separate sections. Only received PRs should trigger notifications.

Speed up popup loading

Right now, the popup only loads after double checking the authentication token. This should be instant, since we already do that in the background.

Show the list of pending pull requests in the popup

Show open pull requests where I'm a reviewer, but no action is needed

This would be helpful in the popup to see all on-going pull requests where I'm a reviewer, but I've already reviewed, to easily get pack to them if necessary.

Consider updating PRs more frequently

See https://gist.github.com/sindresorhus/36b64d5761f47962ab1869d1d559fe52

Show a notification when your own PR is ready to merge

But make it possible to disable notifications, as these aren't urgent and therefore there's no need to break flow.

Allow users to mute a pull request

Sometimes, the author of a PR responds to comments but hasn't yet addressed all of them.

A few different approaches could be used:

1. mute for X hours
2. mute until next commit pushed to the branch
3. mute until review re-requested

I think option 3 makes the most sense, as long as the PR is still accessible via the popup.

Users are getting notifications for their own PRs

Tweak alignment across the app

See https://gist.github.com/sindresorhus/36b64d5761f47962ab1869d1d559fe52

Badges in tabs are slightly misaligned.

Notifications keep popping up every minute

Add tests

A number of bugs could be avoided, both now and in the future, with proper test coverage.

Reduce the number of GitHub requests

We could be a bit smarter with the requests we make on each open PR. For example, we can probably save avoid fetching all previous reviews and comments every time.

We may also be able to reduce requests to list repos, as these only change very occasionally (but when you're added to a new repo, you probably want notifications right away).

Show "Last updated" time in popup + refresh button

My PR is marked as 'Waiting for review' despite of fulfilling merge-ability conditions.

The PRs in 'My PRs' section are marked as 'Waiting for review' despite of fulfilling mergeability conditions configured for our repo:

• having a passing review (out of at least one reviewer, which is our setting, 3 codeowners auto-added as reviewers)
• green required CI run

If the condition is actually waiting for all reviews to complete, maybe just adding a new 'mergeable' badge based on https://developer.github.com/v3/git/#checking-mergeability-of-pull-requests would be enough.

Clicking on notifications does nothing

Mute button should default to previous mute selection

Having to always select Mute until.. gets old really fast. Dropdown is nice, but the primary action should be to repeat what was previously selected.

Green badge when 0 active PRs is obnoxious

When there are 0 active PRs, the extension icon has a badge with 0 on a green background in white text. It's particularly hard to read, and doesn't match other extensions. I would either make it grey, or remove it entirely when there are 0.

Feature Request: Indicate what has happened on the PR

Maybe add an icon or some extra text indicating if a comment/commit/merge happened?

Thoughts?