Reports statistics for a git repo:
- direct commits to master (no Pull Requests)
- self merges (John writes, John merges)
- # and % of commits that are connected to an issue tracker
- # and % of Pull Requests in total commits
- # of revert commits
By mapping git commit authors to team names, you can get results per team rather than per author.
PHP 7.0.x, MySQL 5.x should be installed
- Clone the Repo
- create your local env
cp .env.example .env - Install dependencies
composer install - Create a database named
commit-sniffer - Run migrations
php artisan migrate
Calculate and print statistics for a repo:
./artisan repo:stats [path-to-repo]
Other useful options:
| Option | Description |
|---|---|
| --date-from="yyyy-mm-dd" | Date since |
| --date-to"yyyy-mm-dd" | Date until |
| --metrics=direct,tracked | Comma separated metric names to be displayed (any of direct, self-merges, tracked, pull-requests, reverts) |
Map an author name to a team name:
./artisan repo:map-author [author-name] [team-name]