diff --git a/README.md b/README.md index 830cca2c5..6b48aa8da 100644 --- a/README.md +++ b/README.md @@ -184,6 +184,9 @@ of how to build your own conventions checker. - [GrumPHP does not work with submodules](doc/issues/grumphp-is-not-working-with-submodules.md) +## FAQ +- [FAQ](doc/faq.md) + ## About ### Submitting bugs and feature requests diff --git a/doc/faq.md b/doc/faq.md new file mode 100644 index 000000000..f6df858db --- /dev/null +++ b/doc/faq.md @@ -0,0 +1,12 @@ +## FAQ + +**Which parts of the code does GrumPHP scan?** +> When running `./vendor/bin/grumphp run` all +> files in the repository will be scanned. +> On pre-commit + commit-msg the changed files +> will be scanned. +> Most tasks work directly with these files, +> but there are some commands like `git_blacklist` +> that are able to check only the committed lines. + +