Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

38 lines (26 loc) · 2.28 KB

#Contribute To WordPress SEO

Community made patches, localisations, bug reports and contributions are very welcome and help make WordPress SEO the #1 SEO plugin for WordPress.

When contributing please ensure you follow the guidelines below so that we can keep on top of things.

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

For localization, please refer to translate.yoast.com, though bugs with strings that can't be translated are welcome here.

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.
    • 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.
  • Push the changes to your fork and submit a pull request to the 'master' branch of the WordPress SEO repository.

Code Documentation

  • We ensure that every WordPress SEO function is documented well and follows the standards set by phpDoc.
  • An example function can be found here
  • Please make sure that every function is documented so that when we update our API Documentation things don't go awry!
  • Finally, please use tabs and not spaces. The tab indent size should be 8 for all WordPress SEO code.

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