Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
61 lines (46 sloc) 3.8 KB

Contributing to CMB2

Thank you for your interest in contributing back to CMB2. Please help us review your issues and/or merge your pull requests by following the below guidelines.

NOTE: The issues section is for bug reports and feature requests only.

Support is not offered for this library, and the likelihood that the maintainers will respond is very low. If you need help, please use stackoverflow, or the wordpress.org plugin forums.

Before reporting a bug

  1. Please review the documentation. Most questions revolve around the field types, field parameters, or are addressed in the troubleshooting section.
  2. Search issues to see if the issue has been previously reported.
  3. Install the develop version of CMB2 and test there.

How to report a bug

  1. Specify the version number for both WordPress and CMB2.
  2. Describe the problem in detail. Explain what happened, and what you expected would happen.
  3. Provide a small test-case and a link to a gist containing your entire metabox registration code.
  4. If helpful, include a screenshot. Annotate the screenshot for clarity.

How to contribute to CMB2

All contributions welcome. If you would like to submit a pull request, please follow the steps below.

  1. Make sure you have a GitHub account.
  2. Fork the repository on GitHub.
  3. Check out the develop version of CMB2. If you submit to the master branch, the PR will be closed with a link back to this document.
  4. Verify your issue still exists in the develop branch.
  5. Make changes to your clone of the repository.
    1. Please follow the WordPress code standards.
    2. If possible, and if applicable, please also add/update unit tests for your changes.
    3. Please add documentation to any new functions, methods, actions and filters.
    4. When committing, reference your issue (if present) and include a note about the fix.
  6. Submit a pull request.

Note: You may gain more ground and avoid unecessary effort if you first open an issue with the proposed changes, but this step is not necessary.

Translations

If you are looking to provide language translation files, Please do so via WordPress Plugin Translations.

Creating/Running Tests

We use PHPUnit and the WordPress test suite for our unit/integration tests.

  1. You can install the WordPress test suite using the installer: bash tests/bin/install-wp-tests.sh wordpress_test root ''. (this will install the test suite in the temp folder on your computer, using a test database with those given credentials)
  2. Install PHPUnit via composer, composer install.
  3. Once Composer and the WordPress test sutie are installed, you can run phpunit via ./vendor/bin/phpunit in the CMB2 directory.

Additional Resources

You can’t perform that action at this time.