Skip to content

README.md

Latest commit

History

History
70 lines (54 loc) · 1.9 KB

README.md

File metadata and controls

70 lines (54 loc) · 1.9 KB
Raw

Build StatusCode Climate

Code: The Coderly Toolbelt

code is a command line tool that automates our Coderly development workflow.

code is best aliased as c, so you can type $ c <command> in the shell.

Installation

Dependencies:

  • git 1.7.3 or newer
  • Ruby 2.0 or newer
  • hub

Install hub, for example on OSX:

$ brew install hub

Run hub once in an active git directory to add your credentials

$ hub fetch

Clone the repository to a directory of your choice and run bundle install

$ git clone git@github.com:coderly/code.git
$ cd code
$ bundle install

Add the bin directory to the load paths by opening your .bash_profile and ensure you have the following

PATH=$PATH:$HOME/path-you-cloned-code-to/code/bin
export PATH #Add this if it doesn't already exist

New Feature Workflow

  1. Create a new feature branch
$ code start name of my feature

or equivalently

$ code start name-of-my-feature
  1. When you are ready, publish your code in a pull request
$ code publish my pull request message

Your pull request will be opened up in the browser

  1. Ask someone to review your code by referencing them in a comment in the pull request

  2. When someone gives you a 👍 you can merge it from the pull request page.

    • Make sure that the tests are passing.
    • If the code can't be automatically merged, merge development onto your branch and resolve the conflicts.

  3. After the code has been merged type the following command which deletes your feature branch and updates your development branch

$ code finish