Conversation
mislav
left a comment
There was a problem hiding this comment.
Thank you for the suggestions @outofambit!
| var prCmd = &cobra.Command{ | ||
| Use: "pr", | ||
| Short: "Work with pull requests", | ||
| Short: "Create, view, and checkout pull requests", |
There was a problem hiding this comment.
It's definitely more clear what this offers! I wonder whether we will have to indefinitely have to keep expanding this sentence as we add more actions in the future: update, merge, close, comment on, etc. 🤔 but we haven't reached that bridge yet.
There was a problem hiding this comment.
yeah i was thinking about that too. maybe some things can be grouped under "edit" or "manage pull requests"? or we could just bring back the "work with" phrase at the end of the list
There was a problem hiding this comment.
Yeah I think I like this for now, and we can reassess as we add things. Can easily see us adding "manage" or "edit" as a grouping of things in the near future
command/root.go
Outdated
| Long: `Integrate GitHub into your command-line workflow, starting | ||
| with issues and pull requests. | ||
|
|
||
| (Note: gh is in a very alpha phase.)`, |
There was a problem hiding this comment.
I don't think we need to explicitly spell this out, people should already be aware of this when they're downloading gh?
There was a problem hiding this comment.
they should be, but i didn't see "alpha phase" until i happened to look at the readme for gh-cli. and while i knew that intuitively, it was still helpful to spell it out. i definitely don't feel strongly about this one though!
There was a problem hiding this comment.
I had two separate very conflicting ideas here 😆
-
I feel like we could imply this through displaying the version number. Seeing
0.xwould imply "pre-release". -
Alternatively, we could lean into this as maybe a "greeting" message if that's not too weird? Something like:
Work seamlessly with GitHub from the command line. Welcome to the alpha for gh, let us know your feedback at [email]
cc @billygriffin curious to hear your thoughts here
There was a problem hiding this comment.
I really like the callout on how to give feedback! I might opt for something like this to avoid the use of "alpha," which may not be universally understood or may mean different things to different people:
Work seamlessly with GitHub from the command line. GitHub CLI is in early stages of development, and we'd love to your feedback at [feedback]
I'm curious how we'd use feature preview for this if we went this route. cc: @ohitsmekatie
There was a problem hiding this comment.
I love that! I propose we follow up on the feedback piece in a later PR so we can get these more straightforward fixes in, and suggest we go with this piece alone until then:
Work seamlessly with GitHub from the command line.
command/root.go
Outdated
| Short: "GitHub CLI", | ||
| Long: `Work with GitHub from your terminal`, | ||
| Long: `Work seamlessly with GitHub from your command-line, starting | ||
| with issues and pull requests. |
There was a problem hiding this comment.
These lines shouldn't be indented, since we're in a Go string literal, and the indent will take effect in help text:
$ make && gh
Work seamlessly with GitHub from your command-line, starting
with issues and pull requests.
(Note: gh is in a very alpha phase.)
|
I just pushed a commit to tweak that top line summary since @outofambit is out for a few days! |
ampinsk
left a comment
There was a problem hiding this comment.
This looks good to me, but I'll wait to see if any of the devs spot anything blocking!
mislav
left a comment
There was a problem hiding this comment.
Looking great, thank you @ampinsk @outofambit!
issuehelp summaryprhelp summary