Merge branch 'master' into develop

This commit is contained in:
Weston Ruter 2014-11-10 08:41:45 +11:00
commit ebfc7fa4b3
3 changed files with 38 additions and 4 deletions

2
.gitignore vendored
View file

@ -1,3 +1,5 @@
.buildpath
.project
.settings/
vendor
composer.lock

View file

@ -1,7 +1,12 @@
Ongoing development will be done in the `develop` with merges done into `master`
once considered stable.
# Branches
### Unit Testing
Ongoing development will be done in the `develop` with merges done into `master` once considered stable.
To contribute an improvement to this project, fork the repo and open a pull request to the `develop` branch. Alternatively, if you have push access to this repo, create a feature branch prefixed by `feature/` and then open an intra-repo PR from that branch to `develop`.
Once a commit is made to `develop`, a PR should be opened from `develop` into `master` and named "Next release". This PR will then serve provide a second round of Travis CI checks (especially for any hotfixes pushed directly to the `develop` branch), and provide collaborators with a forum to discuss the upcoming stable release.
# Unit Testing
TL;DR
@ -31,7 +36,7 @@ PEAR installation is intended for ready-to-use not for development. At some poin
might be submitted to `PHP_CodeSniffer` repo and using their existing convention for unit tests
will eventually help them to test the code before merging in.
#### Unit Testing conventions
## Unit Testing conventions
If you see inside the `WordPress/Tests`, the structure mimics the `WordPress/Sniffs`. For example,
the `WordPress/Sniffs/Arrays/ArrayDeclarationSniff.php` sniff has unit test class defined in

27
composer.json Normal file
View file

@ -0,0 +1,27 @@
{
"name" : "wp-coding-standards/wpcs",
"description": "PHP_CodeSniffer rules (sniffs) to enforce WordPress coding conventions",
"keywords" : ["phpcs", "standards", "WordPress"],
"license" : "MIT",
"authors" : [
{
"name" : "X-Team",
"homepage": "http://x-team.com/"
},
{
"name" : "Contributors",
"homepage": "https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/graphs/contributors"
}
],
"require" : {
"squizlabs/php_codesniffer": ">=1.5.4,<2.0"
},
"support" : {
"issues": "https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/issues"
},
"scripts" : {
"post-install-cmd": "\"vendor/bin/phpcs\" --config-set installed_paths ../../..",
"post-update-cmd" : "\"vendor/bin/phpcs\" --config-set installed_paths ../../.."
}
}