|
1 | | -# Laravel GIT commit checker |
| 1 | +# Laravel GIT Commit Checker |
2 | 2 |
|
3 | 3 | [](https://github.com/botble/git-commit-checker/releases) |
4 | 4 | [](LICENSE.md) |
5 | | -[](https://travis-ci.org/botble/git-commit-checker) |
6 | | -[](https://scrutinizer-ci.com/g/botble/git-commit-checker) |
7 | | -[](https://github.styleci.io/repos/204389052) |
8 | 5 | [](https://packagist.org/packages/botble/git-commit-checker) |
9 | 6 | [](https://codeclimate.com/github/botble/git-commit-checker/maintainability) |
10 | 7 |
|
11 | | -## Installation |
| 8 | +## Requirement |
12 | 9 |
|
13 | | -```bash |
14 | | -composer require botble/git-commit-checker |
15 | | -``` |
| 10 | +- Laravel 9.32 or later |
| 11 | +- If you're using Laravel 8.0 or earlier, please use version 1.x |
16 | 12 |
|
17 | | -For version <= 5.4: |
| 13 | +## Installation |
18 | 14 |
|
19 | | -Add to section `providers` of `config/app.php`: |
| 15 | +You can install the package via composer: |
20 | 16 |
|
21 | | -```php |
22 | | -// config/app.php |
23 | | -'providers' => [ |
24 | | - ... |
25 | | - Botble\GitCommitChecker\Providers\GitCommitCheckerServiceProvider::class, |
26 | | -]; |
| 17 | +```shell |
| 18 | +composer require botble/git-commit-checker |
27 | 19 | ``` |
28 | 20 |
|
29 | 21 | Publish the configuration: |
30 | 22 |
|
31 | 23 | ```bash |
32 | | -php artisan vendor:publish --provider="Botble\GitCommitChecker\Providers\GitCommitCheckerServiceProvider" --tag=config |
| 24 | +php artisan vendor:publish --tag=git-commit-checker-config |
33 | 25 | ``` |
34 | 26 |
|
35 | 27 | ### Install GIT hooks |
36 | | -```bash |
37 | | -php artisan git:install-hooks |
38 | | -``` |
39 | 28 |
|
40 | | -- Create default PSR config (It will create phpcs.xml in your root project). |
| 29 | +Run this command to install: |
41 | 30 |
|
42 | | -```bash |
43 | | -php artisan git:create-phpcs |
| 31 | +```shell |
| 32 | +php artisan git-commit-checker:install |
44 | 33 | ``` |
45 | 34 |
|
46 | | -- Run test manually (made sure you've added all changed files to git stage) |
| 35 | +Run test manually (made sure you've added all changed files to git stage): |
47 | 36 |
|
48 | | -```bash |
49 | | -php artisan git:pre-commit |
| 37 | +```shell |
| 38 | +php artisan git-commit-checker:pre-commit-hook |
50 | 39 | ``` |
| 40 | + |
| 41 | +### Changelog |
| 42 | + |
| 43 | +Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. |
| 44 | + |
| 45 | +## Contributing |
| 46 | + |
| 47 | +Please see [CONTRIBUTING](CONTRIBUTING.md) for details. |
| 48 | + |
| 49 | +### Security |
| 50 | + |
| 51 | +If you discover any security related issues, please email contact@dinhquochan.com instead of using the issue tracker. |
| 52 | + |
| 53 | +## Credits |
| 54 | + |
| 55 | +- [Sang Nguyen](https://github.com/sangnguyenplus) |
| 56 | +- [All Contributors](../../contributors) |
| 57 | + |
| 58 | +## License |
| 59 | + |
| 60 | +The MIT License (MIT). Please see [License File](LICENSE) for more information. |
0 commit comments