<commit_before># git-smart

![git-smart logo](https://github.com/geelen/git-smart/raw/master/docs/images/git-smart.png)

Adds some additional git commands to add some smarts to your workflow. These commands follow a few guidelines:

0. It should do the 'right thing' in all situations - an inexperienced git user should be guided away from making simple mistakes.
0. It should make every attempt to explain to the user what decisions it has made, and why.
0. All git commands that modify the repository should be shown to the user - hopefully this helps the user eventually learn the underlying git commands, and when they're relevant.
0. All git commands, destructive or not, and their output should be shown to the user with the -v/--verbose flag. (not implemented yet)

# Installing

All you need to do is grab the gem:

    gem install git-smart

That'll put an executable file for each command as a gem executable. They can be removed by uninstalling the gem.

# Using

Git allows custom commands with a simple convention - `git xyz` tries to find an executable `git-xyz` on the path. So, to run the commands, simply type

    git smart-pull
    git smart-merge <branchname>

# Documentation

The code for each of these commands has been annotated with comments and rendered with [Rocco](https://github.com/rtomayko/rocco):

- [smart-pull](http://github-displayer.heroku.com/geelen/git-smart/raw/master/docs/smart-pull.html)
- [smart-merge](http://github-displayer.heroku.com/geelen/git-smart/raw/master/docs/smart-merge.html)

# Contributing to git-smart

* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it<commit_msg>added the command to the readme to allow coloured output<commit_after># git-smart

![git-smart logo](https://github.com/geelen/git-smart/raw/master/docs/images/git-smart.png)

Adds some additional git commands to add some smarts to your workflow. These commands follow a few guidelines:

0. It should do the 'right thing' in all situations - an inexperienced git user should be guided away from making simple mistakes.
0. It should make every attempt to explain to the user what decisions it has made, and why.
0. All git commands that modify the repository should be shown to the user - hopefully this helps the user eventually learn the underlying git commands, and when they're relevant.
0. All git commands, destructive or not, and their output should be shown to the user with the -v/--verbose flag. (not implemented yet)

# Installing

All you need to do is grab the gem:

    gem install git-smart

That'll put an executable file for each command as a gem executable. They can be removed by uninstalling the gem.

You almost certainly want to run this as well, to allow git commands to be output with colour:

    git config --global color.ui always

Git normally only colours output when being run from the terminal, not from within scripts like these. This sorts that right out.
  
# Using

Git allows custom commands with a simple convention - `git xyz` tries to find an executable `git-xyz` on the path. So, to run the commands, simply type

    git smart-pull
    git smart-merge <branchname>

# Documentation

The code for each of these commands has been annotated with comments and rendered with [Rocco](https://github.com/rtomayko/rocco):

- [smart-pull](http://github-displayer.heroku.com/geelen/git-smart/raw/master/docs/smart-pull.html)
- [smart-merge](http://github-displayer.heroku.com/geelen/git-smart/raw/master/docs/smart-merge.html)

# Contributing to git-smart

* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
{'fraction_non_alphanumeric': 0.07001287001287002, 'fraction_numerical': 0.002059202059202059, 'mean_word_length': 4.040207522697795, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7671280', 'n_tokens_mistral': 1066, 'n_tokens_neox': 1024, 'n_words': 527}