Skip to content

Latest commit

 

History

History
72 lines (55 loc) · 2.93 KB

contributing.md

File metadata and controls

72 lines (55 loc) · 2.93 KB
Raw

Contributing to the StackPath WordPress plugin

If you're reading this, it seems likely you're interested in contributing to the plugin. Thanks a lot! We think that's awesome! Below are some guidelines to help you get started along with some expectations and tips to make the process easier.

Bug reports and pull requests (PRs) are welcome.

Before coding any new features or substantial changes, please open a feature request to discuss the proposed changes and benefits provided to the project.

PRs comprised of whitespace fixes, code formatting changes, or other purely cosmetic changes are unlikely to be merged.

Bugs

Do not open a GitHub issue if the bug is a security vulnerability; instead, email security@stackpath.com.

Before opening an issue, ensure the bug hasn't already been reported. If not, open a new bug report with details demonstrating the unexpected behavior.

PRs are welcome if you've written a patch for a bug.

Pull request guidelines

Please ensure the following when submitting a pull request against the project.

  • A single commit should implement a single logical change.
  • This plugin follows the PSR-1 and PSR-12 style guides. Use your editor's editorconfig features to help.
  • We use composer for development dependency management and the plugin's class autoloader. Non-development dependencies should not be added to the plugin.
  • Changes must target at least PHP 5.6 and WordPress 5.3.0.
  • There should be no commented out code or unneeded files.
  • Documentation should be updated or extended for behavior changes or feature additions.
  • The commit message should be meaningful. We encourage use of the 50/72 rule in your commit message.

For example, here is a meaningful commit message:

Fix an issue purging items that begin with a number

To contrast, here is an example of of a poor commit message. Note that it says literally what changed, but provides no context to readers.

Update the Site class

Opening a pull request

Please follow this process to open a pull request against this project:

  • Fork the project to your personal or organizational GitHub account.
  • Clone your fork.
  • Create a feature branch within your fork to be used for this PR.
  • Make your code updates following the guidelines above.
  • Commit your changes.
  • Push your feature branch to your fork.
  • Open a pull request for the feature branch in your fork against the main project.

For further assistance in opening a PR, see the GitHub PR documentation.