|
1 | | -# Ready to Review 🎯 |
| 1 | +# Ready-to-Review Goose 🪿 |
2 | 2 |
|
3 | | -The smart PR tracker that knows when you're actually blocking someone. Lives in your menubar, tracks GitHub PRs, and plays sound effects when you need to pay attention. |
| 3 | + |
| 4 | + |
| 5 | + |
| 6 | +[](https://github.com/ready-to-review/goose) |
| 7 | + |
| 8 | +The only PR tracker that honks at you when you're the bottleneck. Now shipping with 100% more goose noises! |
| 9 | + |
| 10 | +Lives in your menubar like a tiny waterfowl of productivity shame, watching your GitHub PRs and making aggressive bird sounds when you're blocking someone's code from seeing the light of production. |
| 11 | + |
| 12 | +> ⚠️ **EXPERIMENTAL**: This is very much a work in progress. The blocking logic has bugs. It theoretically runs on Linux, BSD, and Windows but we've literally never tested it there. Here be dragons (and geese). |
4 | 13 |
|
5 | 14 |  |
6 | 15 |
|
7 | | -## Quick Start ⚡ |
| 16 | +## What It Does |
8 | 17 |
|
9 | | -```bash |
10 | | -# Install dependencies: |
11 | | -brew install gh go # macOS (or visit https://cli.github.com) |
12 | | -gh auth login |
| 18 | +- **🪿 Honks** when you're blocking someone's PR (authentic goose noises included) |
| 19 | +- **🚀 Rocket sounds** when own your own PR is ready to go to the next stage |
| 20 | +- **🧠 Smart turn-based assignment** - knows who is blocking a PR, knows when tests are failing, etc. |
| 21 | +- **⭐ Auto-start** on login (macOS) |
13 | 22 |
|
14 | | -# Install & run: |
15 | | -git clone https://github.com/ready-to-review/pr-menubar.git |
16 | | -cd pr-menubar && make run |
17 | | -``` |
| 23 | +You can also visit the web-based equivalent at https://dash.ready-to-review.dev/ |
18 | 24 |
|
19 | | -The app appears in your menubar showing: 🪿 (incoming blocked on you) or 🎉 (outgoing blocked) |
| 25 | +## macOS Quick Start ⚡ (How to Get Honked At) |
20 | 26 |
|
21 | | -## Features |
| 27 | +Install dependencies: the [GitHub CLI, aka "gh"](https://cli.github.com/) and [Go](https://go.dev/): |
22 | 28 |
|
23 | | -- **Smart Notifications**: Desktop alerts + sounds when PRs become blocked (🪿 honk for incoming, 🚀 rocket for outgoing) |
24 | | -- **Comprehensive Coverage**: Tracks PRs you're involved in + PRs in your repos needing reviewers |
25 | | -- **Detailed Tooltips**: Hover to see why you're blocking and what's needed |
26 | | -- **Test-Aware**: Waits for CI to pass before notifying |
27 | | -- **Zero Noise**: No pings for PRs that aren't actually blocked on you |
28 | | -- **One-Click Access**: Open any PR instantly from the menubar |
29 | | -- **Multi-User Support**: Track PRs for different GitHub accounts with `--user` |
30 | | -- **Auto-Start**: macOS "Start at Login" option (when running from /Applications) |
| 29 | +```bash |
| 30 | +brew install gh go |
| 31 | +gh auth login |
| 32 | +``` |
31 | 33 |
|
32 | | -## Installation |
| 34 | +Then summon the goose: |
33 | 35 |
|
34 | 36 | ```bash |
35 | | -make run # Quick install (macOS: installs to /Applications) |
36 | | -make install # Traditional install for your OS |
37 | | -make build # Build only |
| 37 | +git clone https://github.com/ready-to-review/goose.git |
| 38 | +cd goose && make run |
38 | 39 | ``` |
39 | 40 |
|
40 | | -**Requirements**: GitHub CLI (`gh`) authenticated, Go 1.23+ (for building) |
| 41 | +## Known Issues |
| 42 | + |
| 43 | +- Blocking logic is a WIP (we're working on it) |
| 44 | +- Linux/BSD/Windows support is theoretical at best |
| 45 | +- The goose may not stop honking until you review your PRs |
| 46 | + |
| 47 | +## Pricing |
| 48 | + |
| 49 | +This tool is part of the [CodeGroove](https://codegroove.dev) developer acceleration platform: |
| 50 | +- **Forever free** for open-source repositories |
| 51 | +- Low-cost fee TBD for access to private repos (the goose needs to eat) |
41 | 52 |
|
42 | 53 | ## Privacy |
43 | 54 |
|
44 | | -Your GitHub token (from `gh auth token`) is used to fetch PRs and authenticate with our API. We never store it. |
| 55 | +Your GitHub token used to fetch PR metadata but we never store it anywhere. GitHub data is retained strictly for caching purposes with a 20-day maximum TTL. |
45 | 56 |
|
46 | 57 | --- |
47 | 58 |
|
48 | | -Built with ❤️ by [CodeGroove](https://codegroove.dev/products/) • [Contribute](https://github.com/ready-to-review/pr-menubar) |
| 59 | +Built with ❤️ and mild sleep deprivation by [CodeGroove](https://codegroove.dev/products/) |
| 60 | + |
| 61 | +[Contribute](https://github.com/ready-to-review/goose) (PRs welcome, but the goose will judge you) |
0 commit comments