Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix and improve README #56

Merged
merged 1 commit into from
Jun 9, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 11 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,12 @@

:1st_place_medal: Battle-tested coding standard configuration used in Sylius.

Installation & usage
--------------------
## Installation & usage

1. Install this package:

```bash
$ composer require --dev sylius-labs/coding-standard
composer require --dev sylius-labs/coding-standard
Comment on lines -13 to +12
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make this copyable.

```

2. Import the configuration file in your `ecs.php`:
Expand All @@ -19,19 +18,17 @@ Installation & usage
$ecsConfig->import('vendor/sylius-labs/coding-standard/ecs.php');
```

Example config (ecs.php)
------------------------
## Example config (ecs.php)

```php
use Symplify\EasyCodingStandard\Config\ECSConfig;;
return static function (ECSConfig $ecsConfig): void {
$ecsConfig->import('vendor/sylius-labs/coding-standard/ecs.php');
};
```
```php
use Symplify\EasyCodingStandard\Config\ECSConfig;

return static function (ECSConfig $ecsConfig): void {
$ecsConfig->import(__DIR__ . '/vendor/sylius-labs/coding-standard/ecs.php');
};
```
Comment on lines -25 to +29
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix Markdown

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and use absolute paths


Upgrade from YML to PHP config file
-----------------------------------
## Upgrade from YML to PHP config file

Use this [package](https://github.com/symplify/config-transformer) and follow their guidelines
to automatically migrate your YML config to a PHP config file.