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

Version bump 0.2.3 #17

Merged
merged 6 commits into from Mar 20, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github_changelog_generator
@@ -1,2 +1,2 @@
unreleased=true
future-release=0.2.2
future-release=0.2.3
10 changes: 10 additions & 0 deletions CHANGELOG.md
@@ -1,10 +1,20 @@
# Change Log

## [0.2.3](https://github.com/ItinerisLtd/itineris-wp-coding-standards/tree/0.2.3) (2019-03-20)
[Full Changelog](https://github.com/ItinerisLtd/itineris-wp-coding-standards/compare/0.2.2...0.2.3)

**Merged pull requests:**

- Exclude rules [\#16](https://github.com/ItinerisLtd/itineris-wp-coding-standards/pull/16) ([TangRufus](https://github.com/TangRufus))
- Readme: Better comment about `phpcs` arguments [\#15](https://github.com/ItinerisLtd/itineris-wp-coding-standards/pull/15) ([TangRufus](https://github.com/TangRufus))
- Readme: Scan only PHP files [\#14](https://github.com/ItinerisLtd/itineris-wp-coding-standards/pull/14) ([TangRufus](https://github.com/TangRufus))

## [0.2.2](https://github.com/ItinerisLtd/itineris-wp-coding-standards/tree/0.2.2) (2019-02-19)
[Full Changelog](https://github.com/ItinerisLtd/itineris-wp-coding-standards/compare/0.2.1...0.2.2)

**Merged pull requests:**

- Version bump 0.2.2 [\#13](https://github.com/ItinerisLtd/itineris-wp-coding-standards/pull/13) ([TangRufus](https://github.com/TangRufus))
- composer require php:^7.0 [\#12](https://github.com/ItinerisLtd/itineris-wp-coding-standards/pull/12) ([TangRufus](https://github.com/TangRufus))

## [0.2.1](https://github.com/ItinerisLtd/itineris-wp-coding-standards/tree/0.2.1) (2019-02-18)
Expand Down
37 changes: 12 additions & 25 deletions README.md
Expand Up @@ -13,7 +13,6 @@
- [Goal](#goal)
- [Installation](#installation)
- [Usage](#usage)
- [PrettyCI](#prettyci)
- [Required Readings](#required-readings)
- [FAQs](#faqs)
- [Will you add support for older PHP versions?](#will-you-add-support-for-older-php-versions)
Expand All @@ -40,25 +39,26 @@ Using it on [Bedrock](https://github.com/roots/bedrock) or [Sage](https://github

## Installation

```bash
```sh-session
$ composer require --dev itinerisltd/itineris-wp-coding-standards
```

## Usage

First, create [`phpcs.xml`](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-Ruleset) on project root:

```xml
<?xml version="1.0"?>
<ruleset name="MyAwesomePlugin">
<!-- Check all files under project root -->
<file>./</file>

<!-- Show colors in console -->
<arg value="-colors"/>

<!-- Show progress and sniff codes in all reports; Show progress of the run -->
<arg value="sp"/>

<!-- Scan only PHP files -->
<arg name="extensions" value="php"/>

Expand Down Expand Up @@ -89,6 +89,7 @@ First, create [`phpcs.xml`](https://github.com/squizlabs/PHP_CodeSniffer/wiki/An
```

Then, define a composer script:

```json
# composer.json
{
Expand All @@ -99,28 +100,13 @@ Then, define a composer script:
}
```

Run the command:
```php
$ composer check-style
```
Run the commands:

## PrettyCI

Create [`.prettyci.composer.json`](https://prettyci.com/documentation) at project root:
```php
# .prettyci.composer.json
{
"require-dev": {
"itinerisltd/itineris-wp-coding-standards": "^999.999.999"
}
}
```sh-session
$ composer style:check
$ composer style:fix
```

To make [PrettyCI](https://prettyci.com) works, ensure:
- you created [`.prettyci.composer.json`](https://prettyci.com/documentation) at project root
- you created [`phpcs.xml`](#usage) at project root
- versions in `.prettyci.composer.json` are the same as in `composer.json`

## Required Readings

- [Whitelisting code which flags errors](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/wiki/Whitelisting-code-which-flags-errors)
Expand All @@ -141,14 +127,15 @@ Don't use it on **end of life** or **security fixes only** PHP versions.

- Articles on [Itineris' blog](https://www.itineris.co.uk/blog/)
- More projects on [Itineris' GitHub profile](https://github.com/itinerisltd)
- More plugins on [Itineris' wp.org profile](https://profiles.wordpress.org/itinerisltd/#content-plugins)
- Follow [@itineris_ltd](https://twitter.com/itineris_ltd) and [@TangRufus](https://twitter.com/tangrufus) on Twitter
- Hire [Itineris](https://www.itineris.co.uk/services/) to build your next awesome site

### This isn't on wp.org. Where can I give a ⭐️⭐️⭐️⭐️⭐️ review?

Thanks! Glad you like it. It's important to make my boss know somebody is using this project. Instead of giving reviews on wp.org, consider:
Thanks! Glad you like it. It's important to let my boss knows somebody is using this project. Instead of giving reviews on wp.org, consider:

- tweet something good with mentioning [@itineris_ltd](https://twitter.com/itineris_ltd)
- tweet something good with mentioning [@itineris_ltd](https://twitter.com/itineris_ltd) and [@TangRufus](https://twitter.com/tangrufus)
- star this [Github repo](https://github.com/ItinerisLtd/itineris-wp-coding-standards)
- watch this [Github repo](https://github.com/ItinerisLtd/itineris-wp-coding-standards)
- write blog posts
Expand Down
30 changes: 15 additions & 15 deletions composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.