Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

44 lines (29 loc) · 2.63 KB
Raw

How To Contribute

Community made patches, localizations, bug reports and contributions are always welcome and crucial to ensure the WooCommerce Subscription Shortcodes remains working, and your help will be greatly appreciated :)

When contributing please ensure you follow the guidelines below to help us keep on top of things.

Please Note:

GitHub is for bug reports and contributions only - if you have a support question I suggest you follow me on Twitter @sebd86 and send me a tweet. I will follow you back and respond via PM.

How To Submit An Issue Report

If something isn't working, congratulations you've found a bug! Help me fix it by submitting an issue report:

  • Make sure you have a GitHub account
  • Search the Existing Issues to be sure that the one you've noticed isn't already there.
  • Submit a report for your issue
    • Clearly describe the issue (including steps to reproduce it if it's a bug)
    • Make sure you fill in the earliest version that you know that has the issue.
    • Also provide the version of WooCommerce and WooCommerce Subscriptions you were using at the time of the issue.

Making Changes

Making changes to the shortcodes is a key way to help me improve WooCommerce Subscription Shortcodes. You will need some technical skills in PHP to make a change.

If you think something could be improved and you're able to do so, make your changes and submit a Pull Request. I'll be pleased to get it :)

How To Submit A PR

  • Fork the repository on GitHub.
  • Make the changes to your forked repository.
  • When committing, reference your issue number (#1234) and include a note about the fix.
  • Push the changes to your fork and submit a pull request on the master branch of the WooCommerce Subscription Shortcodes repository. Existing maintenance branches will be maintained by me.
  • Please don't modify the changelog - this will be maintained by me.
  • Please don't update the .pot file - this will also be maintained by me.

After you follow the steps above, the next stage will be waiting on me to merge your Pull Request after I have reviewed it. I review them all, and make suggestions and changes as and if necessary.

Additional Resources