stephencelis/ghi

ghi open: Support multiple occurences of "-m" option to set title and description comment in one go like "git commit" does

Open

#260 opened on Nov 28, 2015

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Ruby (134 forks)github user discovery
featurehelp wanted

Repository metrics

Stars
 (2,122 stars)
PR merge metrics
 (PR metrics pending)

Description

The command "git commit" features the "-m" option like ghi but allows multiple occurences. The help of "git commit" says:

   -m <msg>, --message=<msg>
       Use the given <msg> as the commit message.
       If multiple -m options are given, their values are
       concatenated as separate paragraphs.

Currently, ghi takes a second -m option which overwrites the first argument, i.e. re-sets the title. Adding text with newlines as argument to -m does split into title and description already, like this

$ ghi open -m "test issue4
> this should go into description"

but this is not a very convenient style and unusual. Also, the help message does not tell about it. I did take a look into the source code to see this :-)

Contributor guide

Research direction
Modify the argument parsing in ghi to accept multiple m flags and concatenate their values, similar to git commit. Look at the current option parsing (likely using OptionParser) and adjust to handle multiple occurrences. Ensure that the first m sets the title and the subsequent ones add to the description.
Tech stack
ruby
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitRuby
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75