@mattpolzin/harmony 5.6.0 → 5.8.0

package/README.md

@@ -1,4 +1,4 @@
-% harmony(1) Version 5.6.0 | Harmony User's Guide
+% harmony(1) Version 5.8.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]` \
@@ -200,10 +200,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,7 +312,7 @@ organization.
 
 Running `harmony list <team>` will list the members of the given GitHub Team.
 
-## `pr [--draft] [#label, ...]`
+## `pr [--draft] [-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
@@ -328,6 +328,14 @@ editor. If you do not have an `EDITOR` environment variable set, you will still
 be able to enter a description from the command line but PR templates are only
 supported when an `EDITOR` is specified.
 
+If you are creating a new PR from a branch that refers to a GitHub issue (and
+you have GitHub branch parsing enabled in your harmony config) then harmony will
+prepend the issue information onto your new PR description in a commented out
+block for you to reference or copy into the PR description as needed.
+
+You can specify the branch to merge into via the `--into` CLI argument if you
+want to as an alternative to the interactive prompt.
+
 You can also specify any number of labels to apply by prefixing them with '#'.
 For example, `harmony pr #backport #bugfix` would create a PR and apply the
 `backport` and `bugfix` labels.
@@ -351,7 +359,13 @@ Create a PR for the current branch and add the `urgent` label:
 harmony pr #urgent
 ```
 
-## `quick [--bugfix]`
+Create a pull request that will merge into the hypothetical pre-existing
+`release/2_0` branch:
+```shell
+harmony pr --into release/2_0
+```
+
+## `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
@@ -360,6 +374,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.