Skip to content

Commit 5c82847

Browse files
committed
Clarified that minor versions are used for all standard modifications, and major for removals of sniffs (ref #2531)
1 parent 3634776 commit 5c82847

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
## About
22

3-
PHP\_CodeSniffer is a set of two PHP scripts; the main `phpcs` script that tokenizes PHP, JavaScript and CSS files to detect violations of a defined coding standard, and a second `phpcbf` script to automatically correct coding standard violations. PHP\_CodeSniffer is an essential development tool that ensures your code remains clean and consistent.
3+
PHP_CodeSniffer is a set of two PHP scripts; the main `phpcs` script that tokenizes PHP, JavaScript and CSS files to detect violations of a defined coding standard, and a second `phpcbf` script to automatically correct coding standard violations. PHP_CodeSniffer is an essential development tool that ensures your code remains clean and consistent.
44

55
[![Build Status](https://travis-ci.org/squizlabs/PHP_CodeSniffer.svg?branch=phpcs-fixer)](https://travis-ci.org/squizlabs/PHP_CodeSniffer) [![Code consistency](http://squizlabs.github.io/PHP_CodeSniffer/analysis/squizlabs/PHP_CodeSniffer/grade.svg)](http://squizlabs.github.io/PHP_CodeSniffer/analysis/squizlabs/PHP_CodeSniffer) [![Join the chat at https://gitter.im/squizlabs/PHP_CodeSniffer](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/squizlabs/PHP_CodeSniffer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
66

77
## Requirements
88

9-
PHP\_CodeSniffer requires PHP version 5.4.0 or greater, although individual sniffs may have additional requirements such as external applications and scripts. See the [Configuration Options manual page](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Configuration-Options) for a list of these requirements.
9+
PHP_CodeSniffer requires PHP version 5.4.0 or greater, although individual sniffs may have additional requirements such as external applications and scripts. See the [Configuration Options manual page](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Configuration-Options) for a list of these requirements.
1010

1111
If you're using PHP_CodeSniffer as part of a team, or you're running it on a [CI](https://en.wikipedia.org/wiki/Continuous_integration) server, you may want to configure your project's settings [using a configuration file](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage#using-a-default-configuration-file).
1212

1313

1414
## Installation
1515

16-
The easiest way to get started with PHP\_CodeSniffer is to download the Phar files for each of the commands:
16+
The easiest way to get started with PHP_CodeSniffer is to download the Phar files for each of the commands:
1717
```
1818
# Download using curl
1919
curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
@@ -62,12 +62,12 @@ You will then be able to run PHP_CodeSniffer from the tools directory:
6262
./tools/phpcbf -h
6363

6464
### PEAR
65-
If you use PEAR, you can install PHP\_CodeSniffer using the PEAR installer. This will make the `phpcs` and `phpcbf` commands immediately available for use. To install PHP\_CodeSniffer using the PEAR installer, first ensure you have [installed PEAR](http://pear.php.net/manual/en/installation.getting.php) and then run the following command:
65+
If you use PEAR, you can install PHP_CodeSniffer using the PEAR installer. This will make the `phpcs` and `phpcbf` commands immediately available for use. To install PHP_CodeSniffer using the PEAR installer, first ensure you have [installed PEAR](http://pear.php.net/manual/en/installation.getting.php) and then run the following command:
6666

6767
pear install PHP_CodeSniffer
6868

6969
### Git Clone
70-
You can also download the PHP\_CodeSniffer source and run the `phpcs` and `phpcbf` commands directly from the Git clone:
70+
You can also download the PHP_CodeSniffer source and run the `phpcs` and `phpcbf` commands directly from the Git clone:
7171

7272
git clone https://github.com/squizlabs/PHP_CodeSniffer.git
7373
cd PHP_CodeSniffer
@@ -76,7 +76,7 @@ You can also download the PHP\_CodeSniffer source and run the `phpcs` and `phpcb
7676

7777
## Documentation
7878

79-
The documentation for PHP\_CodeSniffer is available on the [Github wiki](https://github.com/squizlabs/PHP_CodeSniffer/wiki).
79+
The documentation for PHP_CodeSniffer is available on the [Github wiki](https://github.com/squizlabs/PHP_CodeSniffer/wiki).
8080

8181
## Issues
8282

@@ -94,13 +94,15 @@ The `MAJOR` version is incremented when:
9494
- backwards-incompatible changes are made to how the `phpcs` or `phpcbf` commands are used, or
9595
- backwards-incompatible changes are made to the `ruleset.xml` format, or
9696
- backwards-incompatible changes are made to the API used by sniff developers, or
97-
- custom PHP_CodeSniffer token types are removed
97+
- custom PHP_CodeSniffer token types are removed, or
98+
- existing sniffs are removed from PHP_CodeSniffer entirely
9899

99100
The `MINOR` version is incremented when:
100101
- new backwards-compatible features are added to the `phpcs` and `phpcbf` commands, or
101102
- backwards-compatible changes are made to the `ruleset.xml` format, or
102103
- backwards-compatible changes are made to the API used by sniff developers, or
103-
- new sniffs are added to an included standard
104+
- new sniffs are added to an included standard, or
105+
- existing sniffs are removed from an included standard
104106

105107
> NOTE: Backwards-compatible changes to the API used by sniff developers will allow an existing sniff to continue running without producing fatal errors but may not result in the sniff reporting the same errors as it did previously without changes being required.
106108

0 commit comments

Comments
 (0)