@mattpolzin/harmony 2.6.2 → 3.1.0

package/README.md

@@ -2,9 +2,11 @@
 # Harmony
 Harmony is a small tool that helps teams keep GitHub reviews running smoothly. It takes the work out of picking someone from a pool of developers to review a new PR. Harmony does this by heuristically determining who on a particular GitHub Team has the least current/recent review workload.
 
+Harmony offers a heuristic for PR assignments that is different than GitHub's round robin or weighted algorithms, but Harmony can also work well even if your team uses GitHub's automatic PR assignments ([see below](#deferring-to-github)).
+
 ## Dependencies
 ### Runtime
-Running Harmony requires NodeJS 14+ (and a local installation of `git`) or alternatively Nix with flakes enabled.
+Running Harmony requires NodeJS 18+ (and a local installation of `git`) or alternatively Nix with flakes enabled.
 
 If you'd like to try Harmony out without even "installing" it and you have Nix installed with flakes enabled, you can run it as `nix run github:mattpolzin/harmony`.
 
@@ -59,7 +61,7 @@ docker pull mattpolzin2/idris-docker:nightly
 
 Then, from a directory containing this Harmony git repository, build Harmony:
 ```shell
-docker run --rm -v "$(pwd):/build" mattpolzin2/idris-docker:nightly bash -c "cd /build && make"
+docker run --rm -v "$(pwd):/build" mattpolzin2/idris-docker:nightly bash -c "apt-get update && apt-get install -y git && cd /build && make"
 ```
 
 At this point you are done with Docker. From the same directory, install Harmony globally:
@@ -73,11 +75,10 @@ Set up Bash completion by adding the following to your Bash resource file or pro
 eval "$(harmony --bash-completion-script)"
 ```
 
-You can set up tab completion in Zsh, too:
+### Zsh completion
+Zsh completion is supported via `bashcompinit` and can be loaded by adding the following to your Zsh resource file or profile:
 ```shell
-autoload -U +X compinit && compinit
-autoload -U +X bashcompinit && bashcompinit
-eval "$(harmony --bash-completion-script)"
+eval "$(harmony --zsh-completion-script)"
 ```
 
 ## Usage
@@ -145,14 +146,15 @@ If `harmony config assignUsers` is `True` (defualt) then harmony will pick someo
 
 You can also require that specific additional users (on top of the one Harmony will pick for you) are assigned to the PR. You do this by specifying those users' logins prefixed with '+' as arguments to Harmony.
 
+You can optionally apply any number of labels to the PR at the same time as assigning reviewers by prefixing the labels with '#'.
+
+#### Deferring to GitHub
 If your team has GitHub set up to auto-assign individuals when a team is requested for review, you probably want to tell harmony not to also pick someone using its heuristics. You can run the following `config` commands to tell harmony to assign a team but not also pick an individual from that team:
 ```shell
 harmony config assignTeams true
 harmony config assignUsers false
 ```
 
-You can optionally apply any number of labels to the PR at the same time as assigning reviewers by prefixing the labels with '#'.
-
 #### Examples
 Assign the most available reviewer from the "developers" GitHub Team:
 ```shell
@@ -227,6 +229,8 @@ Running `harmony health` will graph all open PRs grouped by the month when each
 
 The idea is that a healthy repository does not have many old PRs still open because those PRs represent effort spent by developers that hasn't yet paid off.
 
+![Health Screenshot](./docs/images/health.png)
+
 ### Sync
 Running `harmony sync` will sync the locally configured team slugs and user logins that are used by auto-completion for Harmony. This sync is also performed automatically the first time you run Harmony after more than a day without the configuration being synced.