Skip to content

Latest commit

 

History

History
42 lines (21 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

42 lines (21 loc) · 2.23 KB

Contributing to Performance Improvements for WooCommerce

Thank you for your interest in Performance Improvements for WooCommerce.

Reporting bugs and/or suggesting new features

We welcome input from the community on new features for the plugin, as well as reports of anything that doesn't seem to be working properly.

To make a suggestion or report a bug, please create a new issue within the GitHub repository with a descriptive title and as much pertinent information as possible.

When reporting a bug, please include the following information:

  • Steps to reproduce (what steps would someone need to take to see the bug in action?)
  • The expected behavior (what should happen?)
  • The observed behavior (what is happening?)
  • Information about your WooCommerce instance — this can easily be obtained via the WooCommerce › Status screen, via the "Get system report" button at the top of that page.

Contributing code

If you're interested in contributing to the plugin by way of code and/or documentation, please read the following details about the structure of the project:

Coding conventions

This project adheres to the WordPress coding standards, and an .editorconfig file is included in the repository to help most IDEs adjust accordingly.

Branching strategy

This project uses Gitflow as a branching strategy:

  • develop represents the current development version, whereas master represents the latest stable release.
  • All work should be done in separate feature branches, which should be branched from develop.

Tagging a new release

When a new release is being prepared, a new release/vX.X.X branch will be created from develop, version numbers bumped and any last-minute release adjustments made, then the release branch will be merged (via non-fast-forward merge) into master.

Once master has been updated, the release should be tagged, then master should be merged into develop.