Skip to content

MartinBernstorff/gokid

Repository files navigation

GoKid

GoKid is an opinionated CLI for managing code changes as one unit. It remove the boilerplate work from creating branches and pull requests.

Quick-start

  1. Install the GitHub CLI
brew install gh && gh auth login
  1. Install gokid:
brew update && brew install martinbernstorff/homebrew-tap/gk

or by cloning the repository, and:

cd gokid && go install .

To create your first change (branch + PR):

gokid new "my new PR"

or, using aliases:

gk n "my new PR"

Testing

Workflow

Gokid assumes you name your changes before you start working on them, so:

  1. gokid new "name of change
  2. Branch and PR are created
  3. Work on change
  4. gokid merge, or review/merge through GitHub

Settings

Write the default config to the current directory:

gk init

Gokid looks for configuration files (by priority):

  1. In the current directory
  2. Any parent directory
  3. ~/.config/gokid/.gokid

It uses the values from the first config it encounters.

To get an overview of commands:

gk --help

Roadmap

  • p3: Go through the tdd-course and apply lessons?
  • p3: Rename to warpgate?
  • p2: Add "gokid list", which shows all PRs for current repository
  • p2: Add "gokid close", which closes a PR without merging it

About

You need one branch per pull-request. Why not create both at once?

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors