Skip to content

Latest commit

 

History

History
75 lines (45 loc) · 3.53 KB

README.md

File metadata and controls

75 lines (45 loc) · 3.53 KB

Review Collector Logo

Build Status

Pull requests are often left hanging due to a lack of reviews. You end up either flooding public channels with messages like "@here can anyone review this?" or even worse – manually contacting each person asking them for a review.

With Review Collector, you don't have to do any of this. Review Collector is a Slack Bot that direct messages your colleagues when you request a review from them.

Getting started

Getting started with Review Collector is very simple.

Installation

Add Review Collector to your workspace:

After having authorized the Slack App, you will be asked to connect with GitHub. This is necessary for Review Collector to be able to keep track of your repositories. Review Collector has no rights to access code inside your repositories.

Connecting Slack users to GitHub users

Once installed, Review Collector will be able to watch for necessary events inside your repositories, but for Slack users to be notified they must connect their Slack user with their GitHub user.

All users who wish to either send or recieve review notifications must run the slash-command /connect. You will be prompted with the following:

After having clicked the "Connect with GitHub" button and proceeded with the authorization process you should be notified by Review Collector that the connection was successfull.

Usage

Commands

These are the available commands:

  • /connect – Connects your Slack user to your GitHub user allowing Review Collector to notify you and send notifications from you.
  • /watch <repo-name> – Tells Review Collector to start watching a repository.
  • /unwatch <repo-name> – Tells Review Collector to stop watching a repository.
  • /watching – Lists all repositories you're currently watching.

Example usage

Let's demonstrate the basic flow of Review Collector.

Suppose I have installed Review Collector in my Slack workspace and all of my colleagues have connected their Slack user to their GitHub user with /connect. We are working on a repository called test-repo and want Review Collector to handle its review requests. To tell Review Collector to start watching it I run

/watch test-repo

If everything goes well, Review Collector will respond to you

Now I'm going to create a pull request and add one of my colleagues qwertylorem as a reviewer.

qwertylorem (@Lorem on Slack) instantly gets notified about this.

After a little while, Review Collector notifies me, telling me that @Lorem has approved my pull request.

With my approving review I decide to merge my pull request! 🎉