Merge pull request #120 from liquidweb/feature/compatibility-policy

Define the compatibility policy for the plugin

Author: bswatson

.travis.yml

@@ -10,23 +10,25 @@ cache:
     - $HOME/.composer/cache
 
 php:
+  - 7.4snapshot
   - 7.3
   - 7.2
   - 7.1
   - 7.0
 
+# Compatibility policy:
+#
+# - WordPress: latest -1
+# - WooCommerce: latest -2
+#
+# Note: Since WordPress 5.0+ requires WooCommerce 3.5.1+, we don't need to go back
+#       to WooCommerce 3.4.x. Once 3.7.x is released,
 env:
-  - WP_VERSION=latest WC_VERSION=latest
-  - WP_VERSION=4.9.9 WC_VERSION=latest
-  - WP_VERSION=4.9.9 WC_VERSION=3.4.7
-  - WP_VERSION=4.9.9 WC_VERSION=3.3.5
-  - WP_VERSION=4.9.9 WC_VERSION=3.2.6
+  - WP_VERSION=5.2 WC_VERSION=3.6
+  - WP_VERSION=5.2 WC_VERSION=3.5
+  - WP_VERSION=5.1 WC_VERSION=3.6
+  - WP_VERSION=5.1 WC_VERSION=3.5
 
-# Considerations for the test matrix:
-#
-# - The "WC Requires At Least" is 3.2.6, so that's the lowest we need to go
-# - WordPress < 5.0 doesn't officially support PHP 7.3.
-# - WordPress 5.0 requires at least WooCommerce 3.5.1
 matrix:
   fast_finish: true
   include:
@@ -37,23 +39,14 @@ matrix:
       php: 7.2
       env: WP_VERSION=latest WC_VERSION=latest RUN_CODE_COVERAGE=1
     - name: Bleeding Edge
-      php: 7.3
+      php: nightly
       env: WP_VERSION=trunk WC_VERSION=latest
-  exclude:
-    - php: 7.3
-      env: WP_VERSION=4.9.9 WC_VERSION=latest
-    - php: 7.3
-      env: WP_VERSION=4.9.9 WC_VERSION=3.4.7
-    - php: 7.3
-      env: WP_VERSION=4.9.9 WC_VERSION=3.3.5
-    - php: 7.3
-      env: WP_VERSION=4.9.9 WC_VERSION=3.2.6
   allow_failures:
     - name: Code Coverage
       php: 7.2
       env: WP_VERSION=latest WC_VERSION=latest RUN_CODE_COVERAGE=1
     - name: Bleeding Edge
-      php: 7.3
+      php: nightly
       env: WP_VERSION=trunk WC_VERSION=latest
 
 before_script:

CONTRIBUTING.md

@@ -26,11 +26,23 @@ If you're interested in contributing to the plugin by way of code and/or documen
 
 This project adheres to the [WordPress coding standards](https://make.wordpress.org/core/handbook/best-practices/coding-standards/), and [an `.editorconfig` file](http://editorconfig.org/) is included in the repository to help most <abbr title="Integrated Development Environment">IDE</abbr>s adjust accordingly. The repository also ships with [the WooCommerce git hooks](https://github.com/woocommerce/woocommerce-git-hooks) to aid in development.
 
-As a general rule, we strive to maintain 100% compatibility with [the latest stable release of WooCommerce](https://github.com/woocommerce/woocommerce/releases/latest):
+### Compatibility policy
+
+WooCommerce Custom Orders Table is designed to take advantage of the latest and greatest versions of WordPress and WooCommerce. Keeping both WordPress and WooCommerce up-to-date ensures that stores are able to take advantage of the latest WooCommerce features and security fixes.
 
 [![GitHub release](https://img.shields.io/github/release/woocommerce/woocommerce.svg)](https://github.com/woocommerce/woocommerce/releases/latest)
 
-As part of this commitment to compatibility, WooCommerce Custom Orders Table also targets PHP 5.2 as a minimum PHP version for the core plugin files (with the exception of the `WooCommerce_Custom_Orders_Table_CLI` class, which uses the WP-CLI minimum of PHP 5.3). The `tests/` directory, however, is accepting of modern (7.x) PHP.
+As such, the backwards compatibility policy for WooCommerce Custom Orders Table is:
+
+* The plugin must be compatible with two latest **major** versions of WordPress core (e.g. If the current release of WordPress is 5.2.x, the plugin must be compatible with 5.2.x and 5.1.x).
+* The plugin must be compatible with the three latest **minor** releases of WooCommerce.
+	- WooCommerce 3.0 switched to [semantic versioning](https://woocommerce.wordpress.com/2017/03/13/important-update-regarding-the-upcoming-woocommerce-release-2-7-will-be-3-0-0/), so if WooCommerce 3.7.x is current, the plugin must also be compatible with 3.6.x and 3.5.x.
+* In the case that a WordPress release requires a specific version of WooCommerce (for example, WordPress 5.0 requires WooCommerce 3.5.1 or higher), the WordPress compatibility will supersede the WooCommerce compatibility requirement.
+* Compatibility will be based on the latest **patch** releases of both WordPress and WooCommerce (e.g. if WooCommerce 3.6.2 patches a bug in WooCommerce 3.6.1, our 3.6.x commitment will be 3.6.2 or newer).
+
+As part of this commitment to compatibility, WooCommerce Custom Orders Table will continue to target PHP 5.2 as a minimum PHP version for the core plugin files (with the exception of the `WooCommerce_Custom_Orders_Table_CLI` class, which uses the WP-CLI minimum of PHP 5.3) until WordPress 5.3 is released. At that point, we'll be able to drop support for WordPress 5.1 and, as a result, PHP versions prior to 5.6.
+
+The `tests/` directory, however, is accepting of modern (7.x) PHP.
 
 
 ### Branching strategy
@@ -54,6 +66,8 @@ WooCommerce Custom Orders Table extends WooCommerce's own test suite (which uses
 
 When submitting pull requests, please include relevant tests for your new features and bug-fixes. This helps prevent regressions in future iterations of the plugin, and helps instill confidence in store owners using this to enhance their WooCommerce stores.
 
+Please note that WooCommerce's `master` branch will occasionally include failing tests, which should *not* be treated as a blocker for merging pull requests on this repo as long as the failing tests are within the "core" test suite **and** the same tests are failing against WooCommerce's `master` branch](https://travis-ci.org/woocommerce/woocommerce).
+
 #### Test coverage
 
 [![Coverage Status](https://coveralls.io/repos/github/liquidweb/woocommerce-custom-orders-table/badge.svg?branch=develop)](https://coveralls.io/github/liquidweb/woocommerce-custom-orders-table?branch=develop)

README.md

@@ -17,7 +17,7 @@ WooCommerce Custom Orders Table uses the WooCommerce CRUD design to save order d
 
 ## Requirements
 
-WooCommerce Custom Orders Table requires [WooCommerce 3.2.6 or newer](https://wordpress.org/plugins/woocommerce/).
+WooCommerce Custom Orders Table requires [WooCommerce 3.5.1 or newer](https://wordpress.org/plugins/woocommerce/).
 
 If you're looking to migrate existing order data, [you'll need to have the ability to run WP-CLI commands in your WooCommerce environment](http://wp-cli.org/).
 

woocommerce-custom-orders-table.php

@@ -9,8 +9,8 @@
  * License:              GPL2
  * License URI:          https://www.gnu.org/licenses/gpl-2.0.html
  *
- * WC requires at least: 3.2.6
- * WC tested up to:      3.5.2
+ * WC requires at least: 3.5.1
+ * WC tested up to:      3.6.4
  *
  * @package WooCommerce_Custom_Orders_Table
  * @author  Liquid Web