README

#busfactor

busfactor 生成覆盖率报告，显示每个贡献者对git仓库中每个文件的贡献程度。它有助于确定代码中维护不良/团队不太了解的部分。

如果有人遇到意外，某些文件可能更难维护。

该项目受到Brian Fitzpatrick、Ben Collins-Sussman在GoogleIO上发表的演讲《天才程序员的神话》的启发。

安装

使用composer

composer global require "dav-m85/busfactor=0.2.*"

确保您的全局composer文件夹在您的PATH中。

通过克隆仓库

git clone http://github.com/dav-m85/busfactor.git
cd busfactor
composer install

作为另一个composer项目的依赖项

在您的composer.json中添加以下内容

{
    "require-dev": {
        "dav-m85/busfactor": "0.2.*"
    }
}

然后在您的项目文件夹中

composer install

使用方法

假设您有一个仓库 my/git/repository，您可以使用以下命令生成报告（output/parent/folder 必须可写）

busfactor generate my/git/repository output/parent/folder

然后使用您的浏览器打开 output/parent/folder/index.html。

如果您未指定输出文件夹，报告将自动生成到相对于 busfactor 文件的 out/ 文件夹中。

如果您打算提供生成的文件，请指定一个类似这样的资产-url选项

busfactor generate my/git/repository output/parent/folder --asset-url http://example.com/root/path

贡献

您可以通过各种方式做出贡献

在项目的问题部分报告错误。请确保您知道如何报告一个，阅读此文档可能会有所帮助 ;)

您想要修复一个错误？选择一个问题或填写一个，将问题分配给自己，完成后，提交一个Pull Request。我会尽力及时阅读并批准它。

请注意，该项目遵循语义版本化2.0.0。

您喜欢这个项目吗？分叉它，星标它，讨论它！

测试

测试使用PHPUnit。只需在busfactor项目目录中运行以下命令

vendor/bin/phpunit

鸣谢

维护者：dav-m85

贡献者：Triiistan，你？

许可

busfactor 在MIT许可下发布。可以在项目的这里或https://open-source.org.cn/licenses/mit-license.php找到副本。

相关

https://github.com/lafourchette/gitmirror（从该项目借用Repository类）

daV-m85 / busfactor

维护者

详情

README

安装

使用composer

通过克隆仓库

作为另一个composer项目的依赖项

使用方法

贡献

测试

鸣谢

许可

相关