Skip to content

Latest commit

 

History

History
81 lines (43 loc) · 5.74 KB

CONTRIBUTING.md

File metadata and controls

81 lines (43 loc) · 5.74 KB
Raw

Contributing to WooCommerce Custom Orders Table

Thank you for your interest in contributing to the WooCommerce Custom Orders Table plugin!

Reporting bugs and/or suggesting new features

We welcome input from the community on new features for the plugin, as well as reports of anything that doesn't seem to be working properly.

To make a suggestion or report a bug, please create a new issue within the GitHub repository with a descriptive title and as much pertinent information as possible.

When reporting a bug, please include the following information:

  • Steps to reproduce (what steps would someone need to take to see the bug in action?)
  • The expected behavior (what should happen?)
  • The observed behavior (what is happening?)
  • Information about your WooCommerce instance — this can easily be obtained via the WooCommerce › Status screen, via the "Get system report" button at the top of that page.

Contributing code

If you're interested in contributing to the plugin by way of code and/or documentation, please read the following details about the structure of the project:

Coding conventions

This project adheres to the WordPress coding standards, and an .editorconfig file is included in the repository to help most IDEs adjust accordingly. The repository also ships with the WooCommerce git hooks to aid in development.

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

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, 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

This project uses Gitflow as a branching strategy:

  • develop represents the current development version, whereas master represents the latest stable release.
  • All work should be done in separate feature branches, which should be branched from develop.

Tagging a new release

When a new release is being prepared, a new release/vX.X.X branch will be created from develop, version numbers bumped and any last-minute release adjustments made, then the release branch will be merged (via non-fast-forward merge) into master.

Once master has been updated, the release should be tagged, then master should be merged into develop.

Unit testing

WooCommerce Custom Orders Table extends WooCommerce's own test suite (which uses the WordPress core testing suite) to provide automated tests for its functionality.

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

To generate a code coverage report (test coverage percentage as well as areas of untested or under-tested code that could pose risk), you run the following:

$ composer test-coverage

The report will be saved to tests/coverage/. Please note that XDebug must be enabled in order to generate code coverage reports!