Skip to content

Commit 355e5a6

Browse files
committed
Update README
1 parent a67bf38 commit 355e5a6

1 file changed

Lines changed: 11 additions & 9 deletions

File tree

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# PHP Coding Standards Fixer pre-commit hook
22

3-
A script to run [PHP Coding Standards Fixer](https://github.com/FriendsOfPhp/PHP-CS-Fixer) before committing code.
3+
A script to run [PHP Coding Standards Fixer](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer) before committing code.
44

5-
PHP Coding Standards Fixer is run quietly to avoid unnecessary noise when
6-
committing code. If there are standards violations it is run again in verbose
7-
mode to provide more information about the violations and stop the commit.
5+
The fixer is run **quietly** to avoid unnecessary noise when committing code. If there are violations it is run again in verbose mode to provide more information about the violations in the commit.
86

9-
You can bypass the `pre-commit` with `git commit --no-verify`.
7+
A full check is executed if the configuration or the Composer lock file has changed, otherwise only changed files since the last commit are checked.
108

11-
A full check is done if the PHP Coding Standards configuration or the Composer
12-
dependencies lock file has changed, otherwise only changed files since the last
13-
commit are checked.
9+
This hook is invoked by git-commit, and [can be bypassed](https://git-scm.com/docs/githooks#_pre_commit) with the --no-verify option.
10+
11+
```
12+
git commit --no-verify
13+
```
1414

1515
## Installation
1616

@@ -26,6 +26,8 @@ Make sure the file is executable:
2626

2727
chmod 744 ~/.githooks/pre-commit
2828

29-
Configure Git to use the hooks:
29+
Configure the Git [hooks path](https://git-scm.com/docs/git-config#Documentation/git-config.txt-corehooksPath):
3030

3131
git config --global core.hooksPath ~/.githooks
32+
33+
Done!

0 commit comments

Comments
 (0)