phpro#265: Added a FAQ

benderni · Feb 24, 2017 · 948b5c9 · 948b5c9
1 parent 72d9d20
commit 948b5c9
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git 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
@@ -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.
+
+