Skip to content

Commit 5d8fa77

Browse files
committed
Update readme to explain why
1 parent 01d4bc2 commit 5d8fa77

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33

44
# PHP_Codesniffer baseline
55

6-
PHP_Codesniffer extension to allow baselining existing issues until [PR:3387](https://github.com/squizlabs/PHP_CodeSniffer/pull/3387) is accepted.
6+
To be able to add PHP_Codesniffer or adding new rules to an existing project, it is not always possible to solve
7+
all the new issues that appear. As PHPCodesniffer doesn't have a baseline mechanism and while
8+
[PR:3387](https://github.com/squizlabs/PHP_CodeSniffer/pull/3387) is not accepted yet, this package can be used to
9+
baseline your projects current issues.
710

811
## Getting Started
912

@@ -26,7 +29,8 @@ file and skip errors that are contained within the baseline.
2629

2730
As PHP_Codesniffer doesn't have a nice and clean way to add an extension, this package will inject a single line of code
2831
into the `/vendor/squizlabs/php_codesniffer/src/Files/File.php` upon `composer install` or `composer update`. While this
29-
is a fragile solution, this is only until [PR:3387](https://github.com/squizlabs/PHP_CodeSniffer/pull/3387) is accepted.
32+
is a fragile solution, this is only until [PR:3387](https://github.com/squizlabs/PHP_CodeSniffer/pull/3387) is accepted
33+
or another baseline method has been added.
3034

3135
## About us
3236

0 commit comments

Comments
 (0)