Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

40 lines (28 loc) · 2.52 KB

Contribute To Thematic

Community made patches, localisations, bug reports and contributions are always welcome and are crucial to ensure that Thematic continues to live and evolve together with 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.

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
    • Please take care to write a good commit message. Your message will be part of the history of the repository and a good message helps everyone understand what has happened. Some tips and guidelines can be found in the additional resourse list further down.
  • 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 Thematic repository

Code Documentation

  • We ensure that every Thematic function is documented well and follows the standards set by phpDoc
  • An example function can be found here
  • Finally, please use tabs and not spaces. The tab indent size should be 4 for all Thematic 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