Skip to content

Latest commit

 

History

History
78 lines (53 loc) · 3.77 KB

CONTRIBUTING.md

File metadata and controls

78 lines (53 loc) · 3.77 KB
Raw

Contribution

  • Change the least amount of code to achieve the goal; PRs with lots of whitespace changes and abstraction combined with a feature add or bug fix are difficult to review and may be rejected
  • Use the latest version of WordPress and turn WP_DEBUG on
  • If other plugins are installed during testing that might affect behavior, please list those in the PR description
  • Run the Composer scripts listed below before creating your PR:
    • composer compat to check for PHP version compatibility (currently 5.3; required by CI)
    • composer phpcbf to correct whitespace project-wide (required by CI)
    • composer phpcs-tests to run code standard checks on test files (required by CI)
    • composer phpcbf-tests to run code standard checks on test files (required by CI)
    • composer test to run all tests (required by CI; see Testing below)
    • composer phpcs-path ./path/to/file/changed.php to find other potential issues (not required by CI currently)
  • Please fill out the PR template completely so we can review and merge your contribution quickly!

How to install and configure WordPress for testing

We try to cover as many use cases as possible and one way to do that is with a "headless" WordPress install (core WordPress files in a separate directory). Here's a quick and easy way to set that up on the command line:

mkdir wp-doc-root; cd wp-doc-root; mkdir wp;
mkdir wp-content; mkdir wp-content/themes; mkdir wp-content/plugins;

git clone https://github.com/WordPress/WordPress.git wp;
# Clones the latest, released version or WordPress (takes a while)

cp ./wp/wp-config-sample.php ./wp-config.php;
# Add MySQL DB info and set "WP_DEBUG" to TRUE` in ./wp-config.php

cp ./wp/index.php ./index.php; 
# Replace "/wp-blog-header.php" with "/wp/wp-blog-header.php" in copied ./index.php
 
git clone https://github.com/joshcanhelp/auth0-wp-test.git ./wp-content/themes/auth0-wp-test
# Optional, clones the testing theme to assist with development

For a more complete script, see this Gist.

The main requirement for testing, though, is using the latest version of WordPress with our minimum supported PHP version and testing both single and multi-site setups.

Testing

This plugin is developed and tested in PHP 7.1 using PHPUnit 6. All new features and functionality should also include unit tests coverage. The plugin currently has the WP-CLI test scaffolding, a composer script, and tests for the latest functionality.

WordPress testing is a bit different from typical testing in PHP, mainly because of the need for a working database. To run tests locally, you'll need to install the test suite, which is covered here. Run this install command:

bin/install-wp-tests.sh wordpress_test root '' localhost latest

... changing the options for your local setup. Once that completes successfully, you can run the Composer script:

composer test

... to run all tests or:

composer test-path ./tests/testFiletoRun.php

... to run a specific test.

Please note that we are in the early stages of adding testing to this plugin so feedback on the current setup, including any problems you're having setting it up, are welcome and encouraged in the Issues tab.

CSS pre-processing

You need to install the stylus tool and run this command (from the plugin root):

stylus -c -o assets/css/initial-setup.css assets/css/initial-setup/main.styl

To watch and auto-compile it while working:

stylus -cw -o assets/css/initial-setup.css assets/css/initial-setup/main.styl