hhy5277/git-quick-stats

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

GIT quick statistics

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

Usage git quick-stats

Example: Contribution stats (by author):

Example: Suggested code reviewers (based on git history):

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, commitsPerDay, commitsPerAuthor, myDailyStats, contributors, branchTree, branchesByDate, changelogs

Installation

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

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.