alnutile/codereview

CLI to help with the many steps

dev-master / 1.0.x-dev 2017-06-27 10:53 UTC

README

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads

Roadmap

Features to work on

codereview initailize 

Structure

If any of the following are applicable to your project, then the directory structure should follow industry best practises by being named the following.

bin/        
config/
src/
tests/
vendor/

Install

First install cgr as seen here Then run

$ cgr global require alnutile/codereview:dev-master

So the article here for more details

Global Install Notes

This is how a user can install this for a reliable global install:

Usage

Make a file in your home directory "~/.codereview/config.yml"

in that file build up some keys and values

github_token: "YOUR_GITHUB_TOKEN"
orgs: 
  - org_1
  - org_2

github_token (required)

this will help query github for information

orgs (optional)

makes it easier for you to limit results

gethistory

This will return the history for the user

codereview  gethistory --committer=alnutile

or soon

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

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

if you get an error change the extend of src/SkeletonClass.php to \PHPUnit\Framework\TestCase your install might have setup PHPUnit 6

$ composer test

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email alfrednutile@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.