搜索theshopworks / git-review
一个用于改进Git开发工作流程的工具
Requires
- php: ^7.1.3
- composer/xdebug-handler: ^1.2
- friendsofphp/php-cs-fixer: ^2.16
- fzaninotto/faker: ^1.7
- jakub-onderka/php-console-highlighter: ^0.3.2
- jakub-onderka/php-parallel-lint: ^1.0
- laravel-zero/framework: 5.6.*
- mcampbell508/ci-detector: ^3.2
- mcampbell508/static-review: 5.4
- phpstan/phpstan: ^0.9.2
- spatie/regex: ^1.3
- squizlabs/php_codesniffer: ^3.5
- symfony/console: ^4.1.6
- symfony/yaml: ^4.1
Requires (Dev)
- mockery/mockery: ^1.4.2
- phpunit/phpunit: ^8.2.3
README
一个专为改进Git开发工作流程而设计的工具。
请访问theshopworks.gitlab.io/git-review以获取完整文档。
安装
将git-review包添加到您的composer.json文件中。
{
"require": {
"theshopworks/git-review": "^0.1"
}
}
或者通过Laravel安装根目录下的命令行。
$ composer require "theshopworks/git-review:^0.1"
用法
vendor/bin/git-review
配置文件
您可以将项目配置保存到项目根目录下的git-review.yml.dist或git-review.yml文件中。
注意：如果同时找到
git-review.yml.dist和git-review.yml文件，Git Review将使用git-review.yml配置文件。这在需要本地覆盖选项时很有用。理想的设置是将git-review.yml.dist文件作为项目的一部分提交，然后通过.gitignore文件忽略git-review.yml。
命令
有关此项目的任何命令的信息，可以在文档站点上找到。
代码风格
此项目遵循以下代码风格指南
- PSR-2 & PSR-4编码风格指南。
- 一些选定的PHP-CS-Fixer规则。
$ php vendor/bin/php-cs-fixer fix
测试
$ php vendor/bin/phpunit
文档
此项目的文档可以在docs/文件夹中找到。我们使用静态站点生成器Hexo来生成我们的文档。
文档受Creative Commons Attribution 4.0 Generic License许可，归功于Tommy Chen，原始版本可在此处找到。请参阅LICENSE
文档在每次合并到master时会自动部署到https://theshopworks.gitlab.io/git-review。
要本地构建文档，您需要执行以下操作
需求：在生成文档之前，您需要安装Yarn。
cd docs/
yarn install
./node_modules/.bin/hexo server
要生成/public文件，您还可以使用./node_modules/.bin/hexo generate。
贡献
请参阅CONTRIBUTING以获取详细信息。
许可证
MIT许可证（MIT）。请参阅许可证文件以获取更多信息。