diff --git a/README.md b/README.md index dbd6004..b57b088 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # 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)). +Harmony offers a heuristic for PR review requests 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 review requests ([see below](#deferring-to-github)). ## Dependencies ### Runtime @@ -102,21 +102,21 @@ What repository would you like to use harmony for (ENTER for default: myrepo)? What GitHub remote repo would you like to use harmony for (ENTER for default: origin)? -Would you like harmony to comment when it assigns reviewers? [Y/n] -Would you like harmony to assign teams in addition to individuals when it assigns reviewers? [Y/n] +Would you like harmony to comment when it requests reviewers? [Y/n] +Would you like harmony to request team reviews in addition to individuals when it requests reviewers? [Y/n] Creating config... ``` -Once configured, Harmony supports the following commands: `config`, `branch`, `pr`, `label`, `assign`, `contribute`, `whoami`, `reflect`, `list`, `graph`, `health`, and `sync`. +Once configured, Harmony supports the following commands: `config`, `branch`, `pr`, `label`, `request`, `contribute`, `whoami`, `reflect`, `list`, `graph`, `health`, and `sync`. ### Config Running `harmony config ` will read the given configuration property. `harmony config ` will set the configuration property. Not all configuration properties can be read/set with this command. #### Properties -- `assignTeams` (`true`/`false`) -- When picking a reviewer from a team, assign the team as a reviewer as well. -- `assignUsers` (`true`/`false`) -- When assigning a team as a reviewer, pick a user to review as well. -- `commentOnAssign` (`true`/`false`) -- When assigning a reviewer chosen by Harmony, comment on the pull request. +- `requestTeams` (`true`/`false`) -- When picking a reviewer from a team, request the team as a reviewer as well. +- `requestUsers` (`true`/`false`) -- When requesting a team as a reviewer, pick a user to review as well. +- `commentOnRequest` (`true`/`false`) -- When requesting a reviewer chosen by Harmony, comment on the pull request. - `defaultRemote` (optional string) -- When pushing new branches, what remote destination should be used. - `githubPAT` (optional string) -- If the `$GITHUB_PAT` environment variable is not set, this Personal Access Token is used to authenticate with GitHub. @@ -139,40 +139,41 @@ Running `harmony label {