jenkins-bot has submitted this change and it was merged. Change subject: Improve README, add HISTORY with changelog for 0.2.0 release ......................................................................
Improve README, add HISTORY with changelog for 0.2.0 release Change-Id: I17e7df5e06d4c7d73fa099a4ecb6e55173711f2a --- A HISTORY.md M README.md 2 files changed, 47 insertions(+), 43 deletions(-) Approvals: Legoktm: Looks good to me, approved Polybuildr: Looks good to me, but someone else must approve jenkins-bot: Verified diff --git a/HISTORY.md b/HISTORY.md new file mode 100644 index 0000000..ad51231 --- /dev/null +++ b/HISTORY.md @@ -0,0 +1,21 @@ +# MediaWiki-Codesniffer release history # + +## 0.2.0 / 2015-06-02 ## +* Fixed sniff that checks globals have a "wg" prefix (Divya) +* New sniff to detect unused global variables (Divya) +* New sniff to detect text before first opening php tag (Sumit Asthana) +* New sniff to detect alternative syntax such as "endif" (Vivek Ghaisas) +* New sniff to detect unprefixed global functions (Vivek Ghaisas) +* New sniff to detect "goto" usage (Harshit Harchani) +* Update ignore with some emacs files. (Mark A. Hershberger) +* Use upstream codesniffer 2.3.0 (Kunal Mehta) +* Make mediawiki/tools/codesniffer pass phpcs (Vivek Ghaisas) +* New sniff to check for spacey use of parentheses (Kunal Mehta) +* Modify generic pass test with a case of not-spacey parentheses (Vivek Ghaisas) +* Make failing tests fail only for specific respective reasons (Vivek Ghaisas) +* Change certain errors to warnings (Vivek Ghaisas) +* Update ExtraCharacters Sniff to allow shebang (Harshit Harchani) + +## 0.1.0 / 2015-01-05 ## + +* Initial tagged release diff --git a/README.md b/README.md index 0f55ef2..734dda8 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,32 @@ -# MediaWiki coding conventions +# MediaWiki coding conventions # -## Abstract +## Abstract ## +This project implements a set of rules for use with [PHP CodeSniffer](https://pear.php.net/package/PHP_CodeSniffer). -This project implements a set of rules for use with [PHP CodeSniffer] - -See [MediaWiki conventions] on our wiki :-) - -## How to install - -1. Install PHP Code Sniffer: - -``` -pear install PHP_CodeSniffer -``` - -2. Clone this repository in /some/path - -``` -git clone ... </some/path> -``` - -3. Set up an alias to load the new standard - -``` -alias phpcsmw='phpcs --standard=</some/path>/MediaWiki' -``` - -You might want to add the alias in your shell startup file (ex: ~/.bashrc). - -4. Run - -``` -$ cd /path/to/mediawiki-core -$ phpcsmw includes/Title.php -<warnings and errors are shown> -$ -``` - -Fix & commit +See [MediaWiki conventions](https://www.mediawiki.org/wiki/Manual:Coding_conventions/PHP) on our wiki. :-) -## TODO +## How to install ## +1. Create a composer.json which adds this project as a dependency: + { + "require-dev": { + "mediawiki/mediawiki-codesniffer": "0.2.0" + }, + "scripts": { + "test": [ + "phpcs --standard=vendor/mediawiki/mediawiki-codesniffer/MediaWiki --extensions=php,php5,inc --ignore=vendor -p ." + ] + } + } -* Actually implements the various conventions +2. Install: `composer update` + +3. Run: `composer test` + +4. Fix & commit! + +Note that for most MediaWiki projects, we'd also recommend adding a PHP linter to your `composer.json` – see the [full documentation](https://www.mediawiki.org/wiki/Continuous_integration/Entry_points#PHP) for more details. + + +## TODO ## * Migrate the old code-utils/check-vars.php - -[PHP CodeSniffer]: https://pear.php.net/package/PHP_CodeSniffer -[MediaWiki conventions]: http://www.mediawiki.org/wiki/Manual:Coding_conventions -- To view, visit https://gerrit.wikimedia.org/r/215376 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I17e7df5e06d4c7d73fa099a4ecb6e55173711f2a Gerrit-PatchSet: 3 Gerrit-Project: mediawiki/tools/codesniffer Gerrit-Branch: master Gerrit-Owner: Legoktm <legoktm.wikipe...@gmail.com> Gerrit-Reviewer: Jforrester <jforres...@wikimedia.org> Gerrit-Reviewer: Legoktm <legoktm.wikipe...@gmail.com> Gerrit-Reviewer: Polybuildr <v.a.ghai...@gmail.com> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
