Files
git-quick-stats-mirror/README.md
Lukáš Mešťan ab9b042e35 Update README.md
2017-01-15 18:36:19 +01:00

2.0 KiB

GIT quick statistics

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

screenshot_example

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

Usage

git-quick-stats

Installation

# depencences:
$ apt-get install dialog

# clone & install
$ 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

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.