Skip to content

Latest commit

 

History

History
30 lines (15 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

30 lines (15 loc) · 1.71 KB

Contributions to Gravity PDF

You are more than welcome to create a pull request and contribute to Gravity PDF, but before you do we recommend you open a new issue on GitHub / check if there is an existing ticket and discuss your use-case beforehand.

Guidelines

There are a few guidelines that need to be followed to ensure a smooth pull request. These include:

  1. Adhere to the existing code standard which mostly follows WordPress standards.

  2. All PRs must be to the development branch.

  3. Modifications of the existing codebase must pass all unit tests.

  4. Any additions to the plugin must have appropriate unit tests written.

  5. PRs that don't pass existing unit testing or do not have the proper tests to accompany the changes will not be merged.

  6. Where appropriate, you should also update the Gravity PDF documentation on GitHub by creating a pull request. This ensures we have up-to-date documentation for Gravity PDF with each release. Just make sure you cross reference the PRs in each repo so we can easily keep track.

  7. Once our team is happy with the PR we'll ask you to squash your branch into a single commit, rebase it onto the development branch and push the changes to GitHub. This ensures we keep a clean Git history.

We've put together these guidelines to streamline the contributor process for our team AND ensure code quality.

If you are uncertain whether your PR meets all these requirements: don't worry! If there are problems our friendly team will guide you in the right direction.

Happy Coding.

-- The Gravity PDF Team.