README

路线图

要工作的功能

codereview initailize

结构

如果以下任何一项适用于您的项目，则目录结构应遵循行业最佳实践，并按以下方式命名。

bin/        
config/
src/
tests/
vendor/

安装

首先按照这里的说明安装 cgr，然后运行

$ cgr global require alnutile/codereview:dev-master

有关更多详细信息，请参阅此处的文章

全局安装说明

用户可以通过以下方式可靠地全局安装此工具

使用方法

在您的家目录中创建一个文件 "~/.codereview/config.yml"

在该文件中建立一些键和值

github_token: "YOUR_GITHUB_TOKEN"
orgs: 
  - org_1
  - org_2

github_token (必需)

这将帮助查询 GitHub 以获取信息

orgs (可选)

这可以使您更容易限制结果

gethistory

这将返回用户的历史记录

codereview  gethistory --committer=alnutile

或很快

codereview  gethistory --committer=alnutile --org=alfred-nutile-inc

变更日志

请参阅CHANGELOG以获取有关最近更改的更多信息。

测试

如果您遇到错误，请将 src/SkeletonClass.php 的扩展名更改为 \PHPUnit\Framework\TestCase，您的安装可能已设置 PHPUnit 6

$ composer test

贡献

请参阅CONTRIBUTING和CONDUCT以获取详细信息。

安全

如果您发现任何与安全相关的问题，请通过电子邮件alfrednutile@gmail.com而不是使用问题跟踪器来报告。

致谢

许可协议

MIT 许可协议 (MIT)。请参阅许可文件以获取更多信息。

alnutile / codereview

维护者

详细信息