Download the PHP package dav-m85/busfactor without Composer
On this page you can find all versions of the php package dav-m85/busfactor. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download dav-m85/busfactor
More information about dav-m85/busfactor
Files in dav-m85/busfactor
Package busfactor
Short Description Find out which file in your git is poorly maintained
License MIT
Homepage https://github.com/dav-m85/busfactor
Informations about the package busfactor
busfactor
busfactor generates a coverage report indicating how much each contributor worked on each file of a git repo. It helps pinpoint part of the code that are poorly maintained/known by the teams working on it.
If someone gets hit by a bus, some files may become more difficult to maintain further.
It was inspired by a GoogleIO talk given by Brian Fitzpatrick, Ben Collins-Sussman, The Myth of the Genius Programmer.
Installation
With composer
Make sure your global composer folder is in your PATH.
By cloning the repo
As a dependency in another composer project
Add the following to your composer.json
Then in your project folder:
Usage
Given you have a repository my/git/repository
, you can generate a report with following command
(output/parent/folder
has to be writeable):
Then open output/parent/folder/index.html
with your browser.
If you don't specify an output folder, the report will automatically be generated to out/
folder relative to
busfactor file.
If you intend to serve generated files, specify an asset-url options like this:
Contributing
You can contribute in various ways:
Report bugs in the project issues section. Please make sure you know how to report one, general understanding of this document may help ;)
You want to fix a bug? Take an issue or fill one, assign yourself on it and when done, submit a Pull Request. I'll do my best to read it in a timely fashion and approve it.
Note that this project is following Semantic Versioning 2.0.0.
You like this project? Fork it, star it, talk about it!
Testing
Tests use PHPUnit. Simply run the following command in busfactor project directory:
Credits
Maintainer: dav-m85
Contributors: Triiistan, you?
License
busfactor is released under the MIT license. A copy can be found inside the project http://opensource.org/licenses/mit-license.php
Related
- https://github.com/lafourchette/gitmirror (Repository class was borrowed from this project)
All versions of busfactor with dependencies
symfony/process Version v2.4.2
symfony/yaml Version v2.4.2
symfony/config Version v2.4.2
knplabs/github-api Version 1.2.1
twig/twig Version v1.15.1