docs: add changelog for new v2 release and adjust README

Author: mawiswiss

CHANGELOG.md

@@ -1,8 +1,47 @@
 # Changelog
 
+## v2.0.0 - December 2024
 
-## [Unreleased] - 2024-05-21
+This version is a major release and includes breaking changes.
+Adjust your configuration, apply the fixes and review code for the new version.
+
+### PER Coding Style 2.0
+PER Coding Style 2.0 (https://www.php-fig.org/per/coding-style/) was introduced.
+This leads to some adjustments in the code which most probably can be autofixed with `ecs check --fix`.
+Review your code after running the fixer.
+
+Rules applied to the set can be found here: https://cs.symfony.com/doc/ruleSets/PER-CS2.0.html. This is the base from which we make our own small adjustments.
+"Concat Space" for example, is a rule which has already been applied to the Symfony rule set in the past, which we enforce in the standard everywhere.
+
+### Unify rule sets
+Removed `whatwedo-wordpress.php` and `whatwedo-symfony.php` in favor of `whatwedo-common.php`. If you have used `whatwedo-symfony.php` or `whatwedo-wordpress.php`, you have to switch to `whatwedo-common.php` in the config.
+
+### Update ECS Configuration
+Update your configuration (`ecs.php`) to the new version and adjust to your preferences. See our example file in the root of this repository.
+
+## Technical
+
+### Changed
+- Unify rule sets (https://github.com/whatwedo/PhpCodingStandard/issues/17)
+- Minor update to `symplify/easy-coding-standard 12.4`
+
+### Added
+- DynamicSet `@PER-CS2.0` was added to the configuration (https://github.com/whatwedo/PhpCodingStandard/issues/19)
+- Add `MultilinePromotedPropertiesFixer` (https://github.com/whatwedo/PhpCodingStandard/issues/27)
+- Add `MultilinePromotedPropertiesFixer` (https://github.com/whatwedo/PhpCodingStandard/issues/27)
+- Add `PhpdocToReturnTypeFixer` and `PhpdocToParamTypeFixer`
+- `NoDoctrineMigrationsGeneratedCommentFixer` is now part of the default configuration (https://github.com/whatwedo/PhpCodingStandard/issues/16)
+- `ConcatSpaceFixer` => `'spacing' => 'none'` is now part of the default configuration (https://github.com/whatwedo/PhpCodingStandard/issues/15)
+
+### Removed
+- Remove deprecated `NoTrailingCommaInListCallFixer`
+- `AssignmentInConditionSniff` is skipped
+
+---
+
+## v1.2.5 - March 2024
 
 ### Changed
 
-- update to `symplify/easy-coding-standard ^12`
+- Update to `symplify/easy-coding-standard ^12`
+- Dump Fixer added

README.md

@@ -3,6 +3,7 @@
 # PhpCodingStandard
 
 This project is a set of coding standard rules, which we are using at [whatwedo](https://whatwedo.ch). It's heavily based on [Simplify/EasyCodingStandard](https://github.com/Symplify/EasyCodingStandard).
+It's based on PER Coding Style 2.0 (https://www.php-fig.org/per/coding-style/).
 
 ## Installation
 
@@ -20,26 +21,24 @@ composer require whatwedo/php-coding-standard
 You can run the checks without project specific configuration using one of following commands:
 
 ```
-vendor/bin/ecs check SRC_DIRECTORY --config vendor/whatwedo/php-coding-standard/config/whatwedo-symfony.php # Symfony projects
-vendor/bin/ecs check SRC_DIRECTORY --config vendor/whatwedo/php-coding-standard/config/whatwedo-wordpress.php # WordPress projects
-vendor/bin/ecs check SRC_DIRECTORY --config vendor/whatwedo/php-coding-standard/config/whatwedo-common.php # Common PHP projects
+vendor/bin/ecs check SRC_DIRECTORY --config vendor/whatwedo/php-coding-standard/config/whatwedo-common.php
 ```
 
-
 ### With custom configuration
 
-If you want to add additional checkers or exclude files, you have to create an `ecs.php` file in your own project root directory.
+But we suggest to create an `ecs.php` file in your own project root directory.
+There's a sample configuration file in the root of this repository.
 
 ```php
 <?php
 declare(strict_types=1);
 
 use Symplify\EasyCodingStandard\Config\ECSConfig;
 
-return static function (ECSConfig $ecsConfig): void {
+return static function (ECSConfig $config): void {
     /*
-    // Remove rules with $ecsConfig->skip()
-    $ecsConfig->skip([
+    // Remove rules with $config->skip()
+    $config->skip([
         SlevomatCodingStandard\Sniffs\Variables\UnusedVariableSniff::class => null,
 
         // Explicitly remove some rules in a specific files
@@ -50,7 +49,7 @@ return static function (ECSConfig $ecsConfig): void {
     */
 
     // This need to come last
-    $ecsConfig->sets([__DIR__ . '/vendor/whatwedo/php-coding-standard/config/whatwedo-common.php']);
+    $config->sets([__DIR__ . '/vendor/whatwedo/php-coding-standard/config/whatwedo-common.php']);
 };
 ```