~maelkum/issue

4ed53b5b7e8e7810f3cf2b1ce8b5dd58c57df2b9 — Marek Marecki 8 months ago c079c9b
About the config file
2 files changed, 40 insertions(+), 1 deletions(-)

M README.markdown
A sampleconfig.json
M README.markdown => README.markdown +33 -1
@@ 64,7 64,8 @@ reduce distractions to minimum.
Consider these steps:

- `issue open "Crash on big numbers"` - open an issue,
- `git checkout -b $(issue slug --git deadbeef)` - create new branch using branch name generation,
- `git checkout -b $(issue slug --git deadbeef)` - create new branch using
  branch name generation (or use `issue slug -BC deadbeef`)
- `gdb ./a.out` - debug the program,
- `vim ...` - create a patch,
- `git commit -m 'Fix the crash on big numbers'` - commit the fix,


@@ 122,6 123,37 @@ Issue overview is available with `issue help` command (use `issue help --verbose

----

## Configuration

Configuration file is located in `~/.issueconfig.json`.
See `sampleconfig.json` for a minimal configuration file.

### Slug formats

    {
          "slug.format.default": "@foo"
        , "slug.format.foo": "foo-issue-{short_uid}-{slug}"
    }

To add format `foo` add a `slug.format.foo` key to your config.
Keys available in the format string are:

- `short_uid`: inserts short UID of the issue
- `parent_short_uid`: inserts short UID of the parent issue
- `slug`: inserts slug of the issue

### Prevent branching from non-master branches

    {
        "slug.allow_branching_from": [ "master", "devel" ]
    }

Use the `slug.allow_branching_from` configuration value to set the branches from
which creating new branches is allowed. Issue will complain if you try to create
a branch (using `issue sl -B`) from a branch not on this list.

----

## License

Issue is published under the GNU GPL v3 license.

A sampleconfig.json => sampleconfig.json +7 -0
@@ 0,0 1,7 @@
{
      "author.email": "john.doe@example.com"
    , "author.name": "John Doe"
    , "slug.format.default": "@foo"
    , "slug.format.foo": "foo-issue-{short_uid}-{slug}"
    , "slug.allow_branching_from": [ "master", "devel" ]
}