Skip to content

Commit

Permalink
minor formatting changes requests on PR review
Browse files Browse the repository at this point in the history
  • Loading branch information
joshcanhelp committed Mar 24, 2018
1 parent 48f0cc8 commit e2a2fca
Showing 1 changed file with 19 additions and 10 deletions.
29 changes: 19 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ for more information.

Please see the [Extending page on auth0.com/docs](https://auth0.com/docs/cms/wordpress/extending) for documentation on existing hooks.

We're happy to review and approve new filters and actions that help you integrate even further in this plugin. Please
see the **Contributing** section below for more information.
We're happy to review and approve new filters and actions that help you integrate even further in this plugin. Please see the **Contributing** section below for more information.

## Contributing

Expand All @@ -34,18 +33,28 @@ We're happy to review and approve new filters and actions that help you integrat
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
* Make sure to test against the lowest PHP version supported (see `Requires PHP:` [here](https://github.com/auth0/wp-auth0/blob/master/readme.txt#L5))
* Make sure to test against the lowest PHP version supported (see `Requires PHP:` [here](blob/master/readme.txt#L5))

### 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:

1. `mkdir wp-doc-root; cd wp-doc-root; mkdir wp;`
2. `mkdir wp-content; mkdir wp-content/themes; mkdir wp-content/plugins;`
3. `git clone https://github.com/WordPress/WordPress.git wp; # takes a while`
4. `cp ./wp/wp-config-sample.php ./wp-config.php; # edit to add MySQL DB info and set "WP_DEBUG" to TRUE`
5. `cp ./wp/index.php ./index.php; # replace "/wp-blog-header.php" with "/wp/wp-blog-header.php"`
6. `git clone https://github.com/joshcanhelp/auth0-wp-test.git ./wp-content/themes/auth0-wp-test`
```bash
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
```

The main requirement for testing, though, is using the latest version of WordPress with our minimum supported PHP
version.
Expand All @@ -66,7 +75,7 @@ $ stylus -w -o initial-setup.css initial-setup/main.styl

## Issue Reporting

If you find a bug or if you have a feature request, please report them in [Issues for this repo](https://github.com/auth0/wp-auth0/issues). Please do not report security vulnerabilities in a public GitHub issue tracker. The [Responsible Disclosure Program](https://auth0.com/whitehat) details the procedure for disclosing security issues.
If you find a bug or if you have a feature request, please report them in the [Issues tab](issues). Please do not report security vulnerabilities in a public GitHub issue tracker. The [Responsible Disclosure Program](https://auth0.com/whitehat) details the procedure for disclosing security issues.

## Author

Expand Down

0 comments on commit e2a2fca

Please sign in to comment.