Skip to content

Commit 1eaf287

Browse files
committed
Docs: Warn about thoughtles approving of risky changes
1 parent 8e9163c commit 1eaf287

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

UPGRADE-4.0.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,20 @@ $ vendor/bin/ecs check --ansi src/ tests/ # old
8383
$ vendor/bin/ecs check --ansi # new
8484
```
8585

86-
### 5. Sanity check
86+
### 5. BE CAREFUL WITH SUGGESTED CHANGES! ⚠️
87+
88+
Some of the new default fixers introduced in php-coding-standard 4.0 and 4.1 suggest changes, which - if not
89+
thoughtfully reviewed - can change the code behavior. Especially changes introduced by (but not limited to!):
90+
91+
- PhpdocToPropertyTypeFixer + PropertyTypeHintSniff
92+
- PhpdocToParamTypeFixer + ParameterTypeHintSniff
93+
- PhpdocToReturnTypeFixer + ReturnTypeHintSniff
94+
95+
**Always carefully review the changes suggested by all fixers!** You may want to skip some of the checks
96+
(using `withSkip()`) in the first phase of upgrading to the new version of the coding standard
97+
or you can introduce some of the rules gradually or on a file-by-file basis.
98+
99+
### 6. Sanity check
87100
Besides running your code style checks, you can ensure all predefined checks are loaded as well, by running:
88101

89102
```sh

0 commit comments

Comments
 (0)