@mattpolzin/harmony 5.7.0 → 6.0.0

package/README.md

@@ -1,4 +1,4 @@
-% harmony(1) Version 5.7.0 | Harmony User's Guide
+% harmony(1) Version 6.0.0 | Harmony User's Guide
 
 # NAME
 Harmony - Harmonize with coworkers around GitHub reviewing
@@ -6,14 +6,14 @@ Harmony - Harmonize with coworkers around GitHub reviewing
 # SYNOPSIS
 `harmony branch` \
 `harmony config {property} [value]` \
-`harmony contribute [options] {uri | pr-number}` \
+`harmony contribute [options]` \
 `harmony graph [options] {team-slug}` \
 `harmony health` \
 `harmony help [subcommand]` \
 `harmony label {label} [...]` \
 `harmony list [team-slug]` \
 `harmony pr [options]` \
-`harmony quick` \
+`harmony quick [options]` \
 `harmony reflect` \
 `harmony request {team-slug | +user-login} [options]` \
 `harmony rq {team-slug | +user-login} [options]` \
@@ -48,6 +48,13 @@ particular release will build against.
 Alternatively, you can build Harmony with Docker (see 
 [Docker Build](#docker-build)).
 
+### Testing
+Tests can be run with `make test`. You'll need a few common tools in your `PATH`
+to run all the tests:
+  - `realpath`
+  - `sed`
+  - `xargs`
+
 ## Installation
 For any installation, you need to have a GitHub 
 [Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token).
@@ -200,10 +207,10 @@ Not all configuration properties can be read/set with this command.
 ### Properties
 
 `requestTeams` (`true`/`false`) 
-: When picking a reviewer from a team, request the team as a reviewer as well.
+: When picking a team to review, request review from the whole team, not just one user on the team. If you have GitHub configured to pick a member of a team to review when the team is requested, you probably want to set this to `true` so harmony tells GitHub the team from which GitHub should then pick an individual.
 
 `requestUsers` (`true`/`false`) 
-: When requesting a team as a reviewer, pick a user to review as well.
+: When requesting a team to review, pick a user from the team to review as well. If you have GitHub configured to pick a member of a team to review when the team is requested, you probably want to set this to `false` so harmony does not also pick a user.
 
 `commentOnRequest` (`none`/`name`/`at-mention`) 
 : When requesting a reviewer chosen by Harmony, comment on the pull request or not.
@@ -312,12 +319,13 @@ organization.
 
 Running `harmony list <team>` will list the members of the given GitHub Team.
 
-## `pr [--draft] [-i/--into {<branch-name>}] [#label, ...]`
+## `pr [--draft | --ready] [-i/--into {<branch-name>}] [#label, ...]`
 With a branch checked out will reach out to GitHub to determine if there is an
 open PR for that branch. If there is a PR, Harmony will print a URI that can be
 used to view the PR. If there is not a PR, Harmony will help you create one. New
 and existing PRs can be marked as drafts by specifying the `--draft` flag with
-the `pr` command.
+the `pr` command or they can be marked as ready for review with the `--ready`
+flag. The default behavior for new PRs is to mark them ready.
 
 If you need to create a PR still, you will be prompted for a branch to open the
 PR against (merge into, eventually), a title for the PR, and a description for
@@ -365,7 +373,7 @@ Create a pull request that will merge into the hypothetical pre-existing
 harmony pr --into release/2_0
 ```
 
-## `quick [--bugfix]`
+## `quick [--bugfix] [issue-title] [...]`
 Helps you create a new GitHub issue and a branch to work on that issue all in
 one go. The branch name will be structured such that if you have GitHub branch
 parsing on then the PR you create for the branch later on will refer to the
@@ -374,6 +382,11 @@ issue created now.
 By default the branch created will be prefixed with `feature` but if you specify
 the `--bugfix` flag then the branch's prefix will be `bugfix`.
 
+Any additional arguments other than `--bugfix` will be used as the issue's
+title. If you don't specify the title as additional arguments, you will be
+prompted for one interactively. You will also be prompted for an issue
+description.
+
 ## `reflect`
 Show a summary of your review requests and authored pull requests.