Skip to content

Rename the quick start to Quick start guide and usage #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
imanimanyara merged 1 commit into from
Oct 3, 2026
Merged

Rename the quick start to Quick start guide and usage #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,20 @@ Requires PHP `^8.4.1 || ^8.5` and Laravel `^13.0`.
composer require laranail/git-commit-checker
```

## Quick start
## Quick start guide and usage

### Getting started

1. Run it from a Git checkout in a local environment: `git-commit-checker:install` refuses to write
a hook when `APP_ENV` is not `local` or there is no `.git` directory.
2. Optionally publish the config to change the hooks or the Pint presets. The pre-commit check is on
by default; `GIT_COMMIT_CHECKER_ENABLED=false` switches it off.

```bash
php artisan vendor:publish --tag=laranail::git-commit-checker-config
```

### Usage

```bash
# Write .git/hooks/pre-commit and, optionally, a pint.json preset
Expand Down
Loading