Skip to content

Latest commit

 

History

History
71 lines (43 loc) · 3.69 KB

CONTRIBUTING.md

File metadata and controls

71 lines (43 loc) · 3.69 KB
Raw

Contributing to the WooCommerce Shipping & Tax

Hi! Thank you for your interest in contributing to WooCommerce Shipping & Tax. We appreciate it.

There are many ways to contribute – reporting bugs, feature suggestions, and fixing bugs.

Reporting Bugs, Asking Questions, Sending Suggestions

Open a GitHub issue, that's all. If you want to prefix the title with a “Question:”, “Bug:”, or the general area of the application, that would be helpful but is no means mandatory. If you have write access, add the appropriate labels.

If you're filing a bug, specific steps to reproduce are helpful. Please include what you expected to see and what happened instead.

Setting up WooCommerce Shipping & Tax features

Please refer to our documentation for feature setup.

Running PHPUnit Tests

The WooCommerce Shipping & Tax client tests use WooCommerce's tests installer to get up and running.

In order to successfully bootstrap your testing environment, you'll need the following:

  • mysql
  • mysqladmin
  • svn
  • git
  • phpunit

Once you have the prerequisites, run the tests installer:

./tests/bin/install-wc-tests.sh <db-name> <db-user> <db-pass> [db-host] [wp-version] [wc-version]

For example, if you had a mysql database running on localhost and with the default root user, you could run:

./tests/bin/install-wc-tests.sh wcc_tests root ''

After the tests installer has completed, simply run phpunit from the root of the woocommerce-services plugin directory.

If everything is running correctly, you'll see output like the following:

Installing...
Running as single site... To run multisite, use -c tests/phpunit/multisite.xml
Installing WooCommerce...
Not running ajax tests. To execute these, use --group ajax.
Not running ms-files tests. To execute these, use --group ms-files.
Not running external-http tests. To execute these, use --group external-http.

PHPUnit 4.8.24 by Sebastian Bergmann and contributors.

...............................................

Time: 2.55 seconds, Memory: 32.00Mb

OK (47 tests, 105 assertions)

We're Here To Help

We encourage you to ask for help. We want your first experience with WooCommerce Shipping & Tax to be a good one, so don't be shy. If you're wondering why something is the way it is, or how a decision was made, you can tag issues with [Type] Question or prefix them with “Question:”

License

WooCommerce Shipping & Tax is licensed under GNU General Public License v2 (or later).

All materials contributed should be compatible with the GPLv2. This means that if you own the material, you agree to license it under the GPLv2 license. If you are contributing code that is not your own, such as adding a component from another Open Source project, or adding an npm package, you need to make sure you follow these steps:

  1. Check that the code has a license. If you can't find one, you can try to contact the original author and get permission to use, or ask them to release under a compatible Open Source license.
  2. Check the license is compatible with GPLv2, note that the Apache 2.0 license is not compatible.
  3. Add the code source URL (e.g. a GitHub URL), the files where it's used in the WooCommerce Shipping & Tax and the full license terms to CREDITS.md
  4. Add attribution to the code, if applicable. This line should include the copyright notice of the source, and a reference to the license contained in CREDITS.md