README

A tool designed for improving development workflow with Git.

Please visit theshopworks.gitlab.io/git-review for full documentation.

• Installation
• Usage
• Config File
• Commands
• Code Style
• Testing
• Documentation
• Contributing
• License

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 a git-review.yml file are found, Git Review will use the git-review.yml configuration file. This is useful for overriding options locally, if this is necessary. The recommended setup should ideally be commit the git-review.yml.dist file as part of your project, and then ignore the git-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.