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.
Dependencies:
- git 1.7.3 or newer
- Ruby 2.0 or newer
- hub
Install hub, for example on OSX:
$ brew install hubRun hub once in an active git directory to add your credentials
$ hub fetchClone the repository to a directory of your choice and run bundle install
$ git clone [email protected]:coderly/code.git
$ cd code
$ bundle installAdd 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- Create a new feature branch
$ code start name of my featureor equivalently
$ code start name-of-my-feature- When you are ready, publish your code in a pull request
$ code publish my pull request messageYour pull request will be opened up in the browser
-
Ask someone to review your code by referencing them in a comment in the pull request
-
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.
-
After the code has been merged type the following command which deletes your feature branch and updates your development branch
$ code finish