Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

32 lines (21 loc) · 1.64 KB
Raw

#Contributing to Better Search Replace

Better Search Replace is open source to encourage feedback and community patches.

Please check the guidelines below before contributing to make sure that everything stays in order.

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

Getting Started

  • Submit a ticket for your issue, assuming one does not already exist.
    • Raise it on the 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 repository

Code Documentation

  • Please make sure that every function is documented!
  • If you're adding/editing a function in a class, make sure to add @access {private|public|protected}
  • Finally, please use tabs and not spaces. The tab indent size should be 4 for all code.

Once you've submitted your pull request, it will be reviewed and merged in if all looks good.