Clarify the instructions for the "Unit Testing" section of the contributing guidelines. #767

Open
wants to merge 3 commits into
from

Projects

None yet

3 participants

@stevegrunwell

After a bit of a run-around this morning trying to get unit testing working (see #766), I wanted to help clean up the documentation and make it very clear what needs to be done to get unit tests working in a local copy of the repository.

@@ -12,13 +12,19 @@ Once a commit is made to `develop`, a PR should be opened from `develop` into `m
# Unit Testing
-TL;DR
+When contributing to WPCS, it's recommended that the project has its own copy of `phpcs`, installed via Composer:
@GaryJones
GaryJones Jan 1, 2017 Member

I've never actually thought about just using the dependency version of PHPCS for running tests / submitting PRs upstream to PHPCS itself.

@@ -12,13 +12,19 @@ Once a commit is made to `develop`, a PR should be opened from `develop` into `m
# Unit Testing
-TL;DR
+When contributing to WPCS, it's recommended that the project has its own copy of `phpcs`, installed via Composer:
@jrfnl
jrfnl Jan 1, 2017 Contributor

This is only valid if your preferred method of installation is Composer. The PEAR install comes with the test suite already and if you also develop for PHPCS itself, you probably have a stand-alone PHPCS git clone somewhere which comes with the test suite as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment