Skip to content

Commit 4944c16

Browse files
dd note on config requirements
1 parent c34cd4c commit 4944c16

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/tools/phpcs.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,15 @@ PHPCS supports many coding standards including:
3939
- **PEAR**: PEAR coding standard
4040
- **Zend**: Zend Framework coding standard
4141

42+
## Configuration
43+
44+
PHPCS requires a configuration file to run. CodeRabbit will only run PHPCS if one of the following configuration files is found:
45+
46+
- `phpcs.xml` - XML configuration file
47+
- `phpcs.xml.dist` - Distributed XML configuration file
48+
49+
CodeRabbit will not run PHPCS if no configuration file is found.
50+
4251
## Links
4352

4453
- [PHPCS GitHub Repository](https://github.com/squizlabs/PHP_CodeSniffer)

0 commit comments

Comments
 (0)