Skip to content

Commit

Permalink
Update readme to explain why
Browse files Browse the repository at this point in the history
  • Loading branch information
frankdekker committed Feb 28, 2022
1 parent 01d4bc2 commit 5d8fa77
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@

# PHP_Codesniffer baseline

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

## Getting Started

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

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

## About us

Expand Down

0 comments on commit 5d8fa77

Please sign in to comment.