The Google Chrome extension that allows you to be notified of changes in Pull Requests. Currently only Bitbucket is supported. GitHub support is on the way (see milestones).
The motivation of creating this project is simple.
Developers who work in team on the same project want to have immediate feedback on code they create. They create pull requests and assign people asking for a code review. Assigned people receive email notifications but sometimes they are getting lost in a mass of messages they receive everyday.
I wanted to provide simple and immediate notifications for developers using Bitbucket for repository hosting to make their work easier and more responsive.
Currently project is being used by a small bunch of developers.
Instant feedback and feature requests pushed me to release several versions
and the 0.6.0 version was the last one published before it's been published
on Github.
- Extension popup with a list of assigned and authored pull requests
- Code review progress:
- proportions (3/10 - three people accepted per 10 assigned)
- percentage (25%)
- progress bar
- Pull request preview with detailed info
- target branch
- markdown-formatted description
- list of assignees
- Showing notifications:
- Assigned new pull request
- Accepted pull request
- Updated pull requests
- Comments and replies on a pull request
- Notification sounds
- Sending a reminder to all assignees who haven't approved a PR yet
- Easier PR opening by clicking on a notification or an item on the list
- Google Analytics tracking
- Error and logs tracking with Loggly
- Typescript
- AngularJS
- Webpack
- Gulp
- Karma runner
- Jasmine
- and many more!
Due to API changes, at least version 33.x.x of Google Chrome is required. However, the current version is highly recommended.
To run project on your machine, ensure you have following packages installed:
- node.js >= 6.x
- yarn >= 1.0.0
- gulp - tested with 3.9.1
To install project dependencies, simply run the following command from root directory of the project:
yarn installTo run tests, execute standard npm command:
yarn testIf you want to generate code coverage, you can set GENERATE_COVERAGE=1 environment variable.
Coverage report will be dumped into build/coverage directory.
GENERATE_COVERAGE=1 yarn testThe extension is built with Webpack. There are two ways to build a project: dev and prod.
Running tests also executes build with its own context, so there's also a test environment.
Details of build process are shown in the table below.
Development version of the build results in creating a dist directory
with compiled sources and re-generated extension manifest. You can point your browser
here to run it locally.
To build development version of the project, run the following in your terminal:
yarn run build:devProduction version is almost the same as development but it takes much more time to build
because of more aggressive code uglification. The result of the prod build is a zipped extension,
ready to publish in the store. You can find it in build directory.
To build production version of the project, run the following in your terminal:
yarn run build:prodIf you'd like to create an extension file, ready to use in your browser without publishing it in the store, you can run alternative prod build by calling
yarn run build:crxYou can find the result file with *.crx extension in build directory. To install it, simply drag-and-drop it onto the
extensions page.
Note: To build the CRX file properly, it needs a key for package signature. To point where is your key, use
CRX_PEM_PATHenvironment variable.
| Build step | DEV | TEST | PROD |
|---|---|---|---|
*.ts files compilation |
✅ | ✅ | ✅ |
| tslint checks | ✅ | ✅ | ❌ |
| stylelint checks | ✅ | ✅ | ❌ |
| merging common code | ✅ | ❌ | ✅ |
| generating html views | ✅ | ❌ | ✅ |
| generating html views | ✅ | ❌ | ✅ |
| sources uglifying | ❌ | ❌ | ✅ |
For some cases, e.g. Google Analytics or Loggly integration, you must provide a token to communicate with the service.
This can be made by a DotEnv webpack plugin. To set up your secrets, create a copy of .env.example in the project root
and rename it to .env. Then update desired values.
The
.envfile is ignored by git.
Extension is integrated with Google Analytics. It sends page views, events and custom timings.
To enable tracking, simply insert a tracking code into .env file for GOOGLE_ANALYTICS_KEY variable.
Currently, following events are sending hits to Google Analytics:
- Page views:
- Pop-up
- Background page (when extension starts)
- Options page
- Events:
- Pop-up opened
- Pull request opened and which way it's been opened
- Reminder sent
- Successful connection to server established
- Switch tabs (and which tab)
- Notification shown (and which notification)
- Custom timings:
- How long is pop-up opened?
- How long is notification shown (and closed by user interaction)?
Please read CONTRIBUTING.md for details on the code of conduct, and the process for submitting pull requests.
The project uses SemVer for versioning. For the versions available, see the tags on this repository.
todo
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent