Skip to content

Latest commit

 

History

History
117 lines (71 loc) · 3.32 KB

README.md

File metadata and controls

117 lines (71 loc) · 3.32 KB
Raw

GIT quick statistics

git quick-stats is a simple and efficient way to access various statistics in git repository.

Example

Suggested code reviewers (based on git history): screenshot from 2017-02-04 22-00-30

Asciinema preview: asciicast

Want to contribute? Great! First, read this page.

Usage

git quick-stats
# or 
git-quick-stats

Or you can use (non-interactive) direct execution:

git quick-stats <optional-command-to-execute-directly>

Possible arguments: suggestReviewers, detailedGitStats, commitsByHour, commitsByWeekday, commitsByMonth, commitsPerDay, commitsPerAuthor, myDailyStats, contributors, branchTree, branchesByDate, changelogs

Git log --since and --until arguments

You can set variable _GIT_SINCE, _GIT_UNTIL and limit the git log

eg:

export _GIT_SINCE="2017-20-01"

export _GIT_UNTIL="2017-22-01"

then run git quick-stats (affect all stats, except "My daily status" and "Git changelogs" )

Git log limit

You can set variable _GIT_LIMIT for limited output (it will affect: "Git changelogs" and "Branch tree view" )

eg:

export _GIT_LIMIT=20

Installation

Unix like OS

git clone https://github.com/arzzen/git-quick-stats.git && cd git-quick-stats
sudo make install

For uninstalling, open up the cloned directory and run

sudo make uninstall

OS X (homebrew)

brew install git-quick-stats

Windows (cygwin)

System requirements

  • Unix like OS with a proper shell
  • Tools we use: git ; awk ; sed ; tr ; echo ; grep ; cut ; sort ; head ; uniq ; column.

Contribution

Want to contribute? Great! First, read this page.

Code reviews

All submissions, including submissions by project members, require review. We use Github pull requests for this purpose.

Some tips for good pull requests:

  • Use our code When in doubt, try to stay true to the existing code of the project.
  • Write a descriptive commit message. What problem are you solving and what are the consequences? Where and what did you test? Some good tips: here and here.
  • If your PR consists of multiple commits which are successive improvements / fixes to your first commit, consider squashing them into a single commit (git rebase -i) such that your PR is a single commit on top of the current HEAD. This make reviewing the code so much easier, and our history more readable.

Formatting

This documentation is written using standard markdown syntax. Please submit your changes using the same syntax.

Licensing

MIT see LICENSE for the full license text.