Skip to content
Brandon Hubbard edited this page Oct 1, 2015 · 1 revision

Thanks for reading our contribution guidelines! What do you want to do:

#Filing issues

Please Note: GitHub is for bug reports and code contributions only - if you have a support question or a request for a customization don't post here, go to our Support Forum instead.

How to write a useful bug report

If you think you have found a bug (we acknowledge that that's a possibility), please make sure you're using the latest version of the plugin. If possible check out the latest version from GitHub and see if the bug still exists there.

A useful bug report explains:

  1. What you were trying to achieve.
  2. What you were expecting to happen.
  3. What actually happened, illustrated with screenshots if possible.

Your bug report should also contain your WordPress version and if there are any errors, the exact error text, including line numbers.

#Security issues Please do not report security issues here, but email them to help@idxbroker.com so we can deal with them securely and quickly.

#Contribute to IDX Broker Platinum

Community made patches, localisations, bug reports and contributions are very welcome.

When contributing please ensure you follow the guidelines below so that we can keep on top of things.

Getting Started

If there is no ticket for your issue, submit it first, following the above guidelines.

Making Changes

  • Fork the repository on GitHub
  • Make the changes to your forked repository.
  • Ensure you stick to the WordPress Coding Standards and have properly documented any new functions, actions and filters following the documentation standards.
  • When committing, reference your issue (if present) and include a note about the fix.
  • Push the changes to your fork and submit a pull request.

At this point you're waiting on us to merge your pull request. We'll review all pull requests, and make suggestions and changes if necessary.

Additional Resources

Clone this wiki locally