Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Command line git achievements

tag: v0.0.2

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 bin
Octocat-spinner-32 lib
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .travis.yml
Octocat-spinner-32 Gemfile
Octocat-spinner-32 HISTORY.md
Octocat-spinner-32 LICENSE.txt
Octocat-spinner-32 README.md
Octocat-spinner-32 Rakefile
Octocat-spinner-32 contributing.md
Octocat-spinner-32 git-feats.gemspec
README.md

git-feats Code Climate Dependency Status

git-feats is a command line wrapper for git that allows you to complete feats based on your git usage.

Installation

$ gem install git-feats

git-feats is is best aliased as git, so you can type $ git <command> as you normally would and complete feats.

See alias for instructions.

Usage

With Alias

If you alias git-feats, just keep using git like you always have. Occasionally, you will complete feats and it will look like this:

$ git status

********************************************************************************
                                Feat Completed!                                 
                                 Status Report                                  
                 Viewed the working tree status with git status                 
********************************************************************************

# On branch master
# Changes not staged for commit:
#   (use "git add <file>..." to update what will be committed)
#   (use "git checkout -- <file>..." to discard changes in working directory)
#
#   modified:   README.md
#
no changes added to commit (use "git add" and/or "git commit -a")

Without Alias

If you don't alias git to git-feats you can still use git-feats in place of git:

$ git-feats status

Alias

Add the following to your .bash_profile or other startup script:

alias git=git-feats

.com

git-feats has a sweet web frontend at gitfeats.com.

Linking your account is as easy as:

git config --global feats.key <your api key>

Credits

git-feats was lovingly developed by:

git-feats was inspired by git-achievements.

Contributing

git-feats has a dead simple interface for making feats.

Simply add a feat to the feats file and it will work in the gem.

If you are looking to contribute, that is a great place to start.

Also, git-feats needs the following:

  • Tests (probably RSpec)
  • Code Cleanup

Any suggestions are also welcomed with open arms. Please fork, send pull requests and make issues.

How to contribute

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Copyright

Copyright (c) 2012 Chris Knadler, Jennifer Coryell and Ian Eckert.

See LICENSE for details.

Something went wrong with that request. Please try again.