A static tool to analyze the history of your git repository.
Generated report can be used to spot potential problems in your project
- PHP installed locally (supported versions >7.2)
- composer https://getcomposer.org/
Running following command should be the only needed thing
composer installbasic usage
php index.php analyse ../path/to/the/analyzed/git/repository/ usage with parameters
php index.php analyse --project-name="Project Name" --file-name="outputFileName" ../path/to/the/analyzed/git/repository/ available parameters:
- project-name
- file-name (default "report")
- contributors-count (default 50)
- files-count (default 20)
The corresponding HTML file will be generated. You can open and check it using your web browser.
Files edited most often are also read most often. This means we want to keep them in the cleanest shape. Unfortunately, because they are edited most often, they tend to be the dirtiest one. During any code refactoring, you should consider cleaning those files.
Most active contributors should be used to spot moments when important team members (all group of developers) left the project. This might result in the lack of knowledge transfer and project inconsistency.
More git analysis could be done with those commands: https://github.com/gbyrka/git-log-analysis
This project is on early stage, however, contribution and all suggestions are welcomed!
If you would like to contribute, please follow our Code of Conduct.