mirror of https://github.com/tomgi/git_stats.git synced 2024-12-22 13:32:17 +01:00

GitStats is a git repository statistics generator.

Find a file

Tomasz Gieniusz 46638c5153 examples in readme		2012-10-23 21:28:34 +02:00
bin	activity fix and tests	2012-10-13 11:49:02 +02:00
config/locales	pl localization	2012-10-22 23:22:50 +02:00
lib	using author name instead of email in charts	2012-10-23 20:52:34 +02:00
spec	utf8 encoding in every file	2012-10-23 20:37:42 +02:00
templates	using author name instead of email in charts	2012-10-23 20:52:34 +02:00
.gitignore	gem description	2012-10-08 17:15:29 +02:00
.gitmodules	test repo submodule	2012-10-19 11:11:06 +02:00
.rspec	lazy loading and firsts tests	2012-10-12 18:20:07 +02:00
Gemfile	using my version of lazy_high_charts	2012-10-22 20:57:24 +02:00
git_stats.gemspec	using my version of lazy_high_charts	2012-10-22 20:57:24 +02:00
LICENSE.txt	initial gem	2012-10-08 17:11:11 +02:00
Rakefile	initial gem	2012-10-08 17:11:11 +02:00
README.md	examples in readme	2012-10-23 21:28:34 +02:00

GitStats

GitStats is a git repository statistics generator. It browses the repository and outputs html page with some statistics.

Examples

$ gem install git_stats

$ git_stats repo_path output_directory
$ favorite_browser output_directory/index.html

> repo = GitStats::GitData::Repo.new(path: '.')
> repo.authors
=> [...]
> repo.commits
=> [...]
> commit.files
=> [...]

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Added some feature')
Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
Push to the branch (git push origin my-new-feature)
Create new Pull Request