alnutile / codereview
CLI to help with the many steps
Requires
- php: ~5.6|~7.0
- guzzlehttp/guzzle: ^6.3
- larapack/dd: 1.*
- mnapoli/silly: ^1.5
- mnapoli/silly-pimple: ^1.0
- nesbot/carbon: ^1.22
- symfony/console: ~3.2
- symfony/process: ~3.2
- symfony/yaml: ^3.2
- vlucas/phpdotenv: ^2.4
Requires (Dev)
- mockery/mockery: 0.9.*
- phpunit/phpunit: ~4.0||~5.0||~6.0
- squizlabs/php_codesniffer: ^2.3
This package is auto-updated.
Last update: 2024-11-06 10:25:28 UTC
README
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.