@mattpolzin/harmony 2.1.0 → 2.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- harmony-npm/README.md +7 -2
- harmony-npm/harmony +2422 -1935
- harmony-npm/package.json +1 -1
harmony-npm/README.md
CHANGED
|
@@ -91,7 +91,7 @@ Would you like harmony to assign teams in addition to individuals when it assign
|
|
|
91
91
|
Creating config...
|
|
92
92
|
```
|
|
93
93
|
|
|
94
|
-
Once configured, Harmony supports the following commands: `config`, `branch`, `pr`, `label`, `assign`, `contribute`, `whoami`, `reflect`, `list`, `graph`, and `sync`.
|
|
94
|
+
Once configured, Harmony supports the following commands: `config`, `branch`, `pr`, `label`, `assign`, `contribute`, `whoami`, `reflect`, `list`, `graph`, `health`, and `sync`.
|
|
95
95
|
|
|
96
96
|
### Config
|
|
97
97
|
Running `harmony config <property>` will read the given configuration property. `harmony config <property> <value>` will set the configuration property.
|
|
@@ -110,7 +110,7 @@ Running `harmony branch` will print the URI for accessing the currently checked
|
|
|
110
110
|
Many operating systems have an `open` command (though the name "open" is not ubiquitous); this means you can run something like `open $(harmony branch)` to open a web browser to the current branch on GitHub.
|
|
111
111
|
|
|
112
112
|
### PR
|
|
113
|
-
Running `harmony pr` 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.
|
|
113
|
+
Running `harmony pr [--draft]` 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 PRs can be created as drafts by specifying the `--draft` flag with the `pr` command.
|
|
114
114
|
|
|
115
115
|
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 the PR. If you have an `EDITOR` environment variable set, Harmony will use that editor to get the PR description from you. If you have a PR template at `.github/PULL_REQUEST_TEMPLATE.md`, Harmony will also preload that into your 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.
|
|
116
116
|
|
|
@@ -189,6 +189,11 @@ Running `harmony graph <team>` will graph the relative review workload of each o
|
|
|
189
189
|
|
|
190
190
|
You can optionally graph completed PR reviews with the `--completed` flag as well, though these are not considered for Harmony's weighting algorithm for review workload.
|
|
191
191
|
|
|
192
|
+
### Health
|
|
193
|
+
Running `harmony health` will graph all open PRs grouped by the month when each was created.
|
|
194
|
+
|
|
195
|
+
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.
|
|
196
|
+
|
|
192
197
|
### Sync
|
|
193
198
|
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.
|
|
194
199
|
|