Giter VIP home page Giter VIP logo

github-flow's Introduction

github-flow

git flow esque helpers, designed with github in mind.

Installation

To install, run the installation script:

curl https://raw.github.com/github-flow/github-flow/v1.1/install.sh | $(which bash)

To update, run the install script again.

To install or update outside the default directory, pass a folder as the first parameter to bash.

Usage

Usage is very similar to git-flow

git hub-clone <org/repo> Fork and clone a repository to use with git hub-flow.

git hub-feature start <feature> Begin working on a new feature.

git hub-feature update [feature] Bring master branch up to date, and rebase feature off master.

git hub-feature publish [feature] Push changes on feature to origin repository.

git hub-feature review [feature] Open pull request on upstream/feature against origin/feature.

git hub-feature finish [feature] Merge pull request for this feature, and prune branches.

All commands with [feature] either take a parameter to specify the branch, or work off the current (non-master) branch.

Configuration

Repositories are configured using three properties under github-flow: origin, upstream, and master. Origin and upstream are the logical remotes. upstream is the canonical upstream project, usually owned by an organization. origin is the users' fork, generally owned by the user's account. 'master' is the logical primary development branch, usually either "master" or "develop". By default, the values are the same as their keys. To use the traditional git-flow model of branching and working off develop, in a local repository run git config --local --add github-flow.master develop

TODO, Bugs

See the bug tracker.

github-flow's People

Contributors

davidsouther avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.