Skip to content

Latest commit

 

History

History
31 lines (23 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

31 lines (23 loc) · 2.16 KB

#Contributing

Getting Started

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 (if applicable).
  • If it's a 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
  • From the develop branch on your forked repository, create a new branch and make your changes
    • It is suggested that your new branch use a name that briefly describes the feature or issue.
    • Ensure you stick to the WordPress Coding Standards
  • When committing, use a well-formed commit message
  • Push the changes to your fork and submit a pull request to the develop branch of the plugin's repository

Code Documentation

  • Code comments should be added to all new functions/methods.
  • Comments should tell you the "what" & "why". You'll typically want a one-liner that says what it does, hopefully why, but not how. Only very rarely should they tell you how (e.g. when the code is necessarily complex).
  • Also see the WordPress PHP Documentation Standards doc for general guidelines and best practices.
  • We currently suggest implementing the @param & @return PHPdoc tags for every function/method if applicable.

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.

Additional Resources