Contribute to Off-Canvas Sidebars

Community made patches, localizations, bug reports, and contributions are always welcome and are crucial to ensure that this plugin remains alive and strong.

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

Getting Started

• Submit a ticket for your issue, assuming one does not already exist.
  • https://github.com/JoryHogeveen/off-canvas-sidebars/issues
  • 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
• Create a new branch, named with a issue prefix (if present) and some keywords on what is changed.
  • Example: #123-what-is-changed.
• Make the changes to your forked repository's code
  • When committing, reference your issue (if present) and include a note about the fix.
  • Ensure you stick to the WordPress Coding Standards
  • This repository contains all files needed to properly configure your IDE with the correct coding standards and code style configuration.
    • PHP MD
    • PHP CS
    • ESLint
    • CSSLint
• If the changes are a new feature make sure you add PHP Unit tests or at least contribute in creating tests.
• Push the changes to the branch you created and submit a pull request for the dev branch.

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

• General GitHub documentation
• GitHub pull request documentation