Skip to content
This repository has been archived by the owner on Jan 20, 2020. It is now read-only.

Latest commit

 

History

History
33 lines (23 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

33 lines (23 loc) · 2.13 KB

Contribute To WP Rocket

Community made patches, localisations, bug reports and contributions are always welcome to WP Rocket, and help us improve the product and stay as the most recommended one by the community.

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

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

Getting Started

  • Do not report potential security vulnerabilities here. Email them privately to our security team at contact@wp-media.me
  • Before submitting a ticket, please be sure to replicate the behavior with no other plugins active and on a base theme like Twenty Seventeen.
  • Submit a ticket for your issue, assuming one does not already exist.
    • Raise it on our Issue Tracker
    • Clearly describe the issue including steps to reproduce the bug.
    • Make sure you fill in the earliest version that you know has the issue as well as the version of WordPress you're using.

Making Changes

  • Fork the repository on GitHub
  • Make the changes to your forked repository
  • When committing, reference your issue (if present) and include a note about the fix
  • If possible, and if applicable, please also add/update unit tests for your changes
  • Push the changes to your fork and submit a pull request to the 'master' branch of the WP Rocket repository

Code Documentation

  • We ensure that every WP Rocket function is documented well and follows the standards set by phpDoc
  • Please make sure that every function is documented so that when we update our API Documentation things don't go awry!
  • Finally, please use tabs and not spaces. The tab indent size should be 4 for all WP Rocket code.

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.