2017 © Pedro Peláez
 

library codereview

CLI to help with the many steps

image

alnutile/codereview

CLI to help with the many steps

  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 1 Versions
  • 0 % Grown

The README.md

codereview

Latest Version on Packagist ![Software License][ico-license] Build Status ![Coverage Status][ico-scrutinizer] Quality Score ![Total Downloads][ico-downloads], (*1)

, (*2)

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., (*3)

bin/        
config/
src/
tests/
vendor/

Install

First install cgr as seen here Then run ``` bash $ cgr global require alnutile/codereview:dev-master, (*4)


So the article [here](https://medium.com/@alnutile/php-cli-skeleton-c054eedde48f) 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, (*5)



### 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, (*6)


or soon

codereview gethistory --committer=alnutile --org=alfred-nutile-inc, (*7)



## Change log Please see [CHANGELOG](CHANGELOG.md) 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 ``` bash $ composer test

Contributing

Please see CONTRIBUTING and CONDUCT for details., (*8)

Security

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

Credits

License

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

The Versions