From 5f1c0acbef8567b87caf8c7ec3dcb63bb630a0d6 Mon Sep 17 00:00:00 2001 From: Tomas Votruba Date: Tue, 22 Aug 2023 09:50:46 +0200 Subject: [PATCH] cleanup --- README.md | 21 ++++----------------- 1 file changed, 4 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index a611e995..a58d6bf1 100644 --- a/README.md +++ b/README.md @@ -50,9 +50,7 @@ Pick what you need, drop the rest. ## 3. How we use Configurable Rules -Last but not least, configurable rules with *saints defaults*. That's just polite wording for *opinionated*, like [`AllowedExclusiveDependencyRule`](https://github.com/symplify/phpstan-rules/blob/main/docs/rules_overview.md#allowedexclusivedependencyrule). - -You might not like them, but maybe you do: +Last but not least, configurable rules with *saints defaults*: ```yaml # phpstan.neon @@ -60,11 +58,10 @@ includes: - vendor/symplify/phpstan-rules/config/configurable-rules.neon ``` -Give it a trial run... so many erros and unclear feedback.... Would you like to **configure them yourself?** -That's good! We use one rule by another in other projects too, instead of one big import. +Would you like to **configure them yourself?** - **Pick one and put it to your `phpstan.neon` manually**. -- Configure it to your specific needs and re-run PHPStan. It's easier to be responsible, when you're in control. +- Configure it to your specific needs and re-run PHPStan. E.g. `ForbiddenNodeRule`: @@ -80,16 +77,6 @@ services: - PhpParser\Node\Expr\ErrorSuppress ``` -You'll find them all in [rules overview](docs/rules_overview.md). - -Happy coding! -
-## Report Issues - -In case you are experiencing a bug or want to request a new feature head over to the [Symplify monorepo issue tracker](https://github.com/symplify/symplify/issues) - -## Contribute - -The sources of this package are contained in the Symplify monorepo. We welcome contributions for this package on [symplify/symplify](https://github.com/symplify/symplify). +Happy coding!