Gherkin Shell Ruby CSS HTML Makefile
Latest commit a9ee50e Feb 7, 2017 @charlierudolph charlierudolph committed with charlierudolph 3.0.0

README.md

Git Town

Build Status License

Git Town makes software development teams who use Git even more productive and happy. It adds Git commands that support GitHub Flow, Git Flow, the Nvie model, GitLab Flow, and other workflows more directly, and it allows you to perform many common Git operations faster and easier.

See git-town.com for documentation.

Commands

Git Town provides these additional Git commands:

Development Workflow

Repository Maintenance

Configuration and Help

  • git town - general Git Town help, view and change Git Town configuration

Installation

Git Town runs anywhere Git and Bash run. Check out our installation instructions for more details.

Aliasing

Each command can be aliased individually to remove the town- prefix with:

git config --global alias.hack town-hack

As a convenience, you can add or remove global aliases for all git-town commands with:

git town alias <true | false>

Configuration

Git Town is configured on a per-repository basis. Upon first use in a repository, you will be prompted for the required configuration. Use the git town command to view or update your configuration at any time.

Required configuration

Optional Configuration

The following configuration options have defaults, so the configuration wizard does not ask about them.

  • the pull branch strategy

    • how to sync the main branch / perennial branches with their upstream
    • default: rebase
    • possible values: merge, rebase
  • the git-hack push flag

    • whether or not newly-hacked branches should be pushed to remote repo
    • default: true
    • possible values: true, false

Documentation

In addition to the online documentation here, you can run git town on the command line for an overview of the Git Town commands, or git help <command> (e.g. git help sync) for help with an individual command.

Contributing

Found a bug or have an idea for a new feature? Open an issue or - even better - get down, go to town, and fire a feature-tested pull request our way! Check out our contributing guide to start coding.