theshopworks / git-review
A tool to improve development workflow with 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
A tool designed for improving development workflow with Git.
Please visit theshopworks.gitlab.io/git-review for full documentation.
Installation
Add the git-review
package to your composer.json
file.
{
"require": {
"theshopworks/git-review": "^0.1"
}
}
Or via the command line in the root of your Laravel installation.
$ composer require "theshopworks/git-review:^0.1"
Usage
vendor/bin/git-review
Config File
You can save the project configuration in a git-review.yml.dist
or git-review.yml
file in the root directory of your project.
Note: If both a
git-review.yml.dist
and agit-review.yml
file are found, Git Review will use thegit-review.yml
configuration file. This is useful for overriding options locally, if this is necessary. The recommended setup should ideally be commit thegit-review.yml.dist
file as part of your project, and then ignore thegit-review.yml
via the.gitignore
file.
Commands
Information relating to any commands for this project, can be found on the docs site.
Code Style
This project follows the following code style guidelines:
- PSR-2 & PSR-4 coding style guidelines.
- Some chosen PHP-CS-Fixer rules.
$ php vendor/bin/php-cs-fixer fix
Testing
$ php vendor/bin/phpunit
Documentation
Documentation for this project can be found in the docs/
folder. We use a static site generator Hexo, to generate our documentation.
The documentation is licensed under a Creative Commons Attribution 4.0 Generic License. It is attributed to Tommy Chen, and their original version can be found here. Please see, the LICENSE
The docs are automatically deployed to https://theshopworks.gitlab.io/git-review, on every merge of master
.
To build the docs locally, you will need to do the following:
REQUIREMENT: You will need to install Yarn, before you can genarate the docs.
cd docs/
yarn install
./node_modules/.bin/hexo server
To generate the /public
files, you can also use ./node_modules/.bin/hexo generate
.
Contributing
Please see CONTRIBUTING for details.
License
The MIT License (MIT). Please see License File for more information.