Skip to content

Commit

Permalink
README and CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
srtfisher committed Aug 29, 2023
1 parent b6921a5 commit df96949
Showing 1 changed file with 4 additions and 43 deletions.
47 changes: 4 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,53 +64,14 @@ You can create a custom ruleset for your project that extends or customizes thes
</ruleset>
```

## Using Alley Coding Standards on PHP 8.1

If you plan on using this ruleset on PHP 8.1, you will need to make some
modifications to your Composer configuration. For some context, the current
version of this ruleset requires `wp-coding-standards/wpcs` 2.3. This package is
not compatible with PHP 8.1 and runs into some issues when being used. Until
`wp-coding-standards/wpcs` 3.0 is released we can use a forked version of the
package that is compatible with PHP 8.1.

### 1. Add the Repository

Add the Composer repository to your project's `composer.json` file:

```json
{
"repositories": {
"wpcs": {
"type": "vcs",
"url": "https://github.com/alleyinteractive/WordPress-Coding-Standards"
}
}
}
```

### 2. Switch to the Forked Version

Add the following to your `composer.json` file `autoload-dev` section:

```json
{
"require-dev": {
"alleyinteractive/alley-coding-standards": "^1.0",
"wp-coding-standards/wpcs": "dev-php-8-1 as 2.3.x-dev"
},
}
```

### 3. Run `composer update`

If you run into any problems, please open an issue. After
`wp-coding-standards/wpcs` 3.0 is released we will remove the above fork from
our projects and rely on the official release.

## Change Log

This project adheres to [Keep a CHANGELOG](https://keepachangelog.com/en/1.0.0/).

### 1.0.1

- Ignore deprecation errors in WPCS to allow it work with PHP 8.0+.

### 1.0.0

- No changes, tagging a stable release of Alley Coding Standards.
Expand Down

0 comments on commit df96949

Please sign in to comment.