Contributing guidelines

This commit is contained in:
Mike Jolley 2012-11-06 12:22:42 +00:00
parent 47f62e777b
commit 3847461602
1 changed files with 32 additions and 0 deletions

32
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,32 @@
# How to contribute
Community made patches, localisations, bug reports and contributions are always welcome are are crucial to ensure WooCommerce remains the #1 eCommerce platform for WordPress ;)
When contributing please ensure you follow the guidelines below so that we can keep on top of things.
__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. Use [WooThemes Support](http://support.woothemes.com) and [WooJobs](http://jobs.woothemes.com) respectively.
## Getting Started
* Make sure you have a [GitHub account](https://github.com/signup/free)
* Submit a ticket for your issue, assuming one does not already exist.
* Clearly describe the issue including steps to reproduce when it is a bug.
* Make sure you fill in the earliest version that you know has the issue.
## Making Changes
* Fork the repository on GitHub
* Make the changes to your forked repository
* Ensure you stick to the [WordPress Coding Standards](http://codex.wordpress.org/WordPress_Coding_Standards)
* Ensure you use LF line endings - no crazy windows line endings :)
* When committing, reference your issue (#1234) and include a note about the fix
* Push the changes to your fork and submit a pull request on the master WooCommerce repository
At this point you're waiting on us to merge your pull request. We'll review all pull requests, and made suggestions and changes if necessary.
# Additional Resources
* [General GitHub documentation](http://help.github.com/)
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
* [WooCommerce Docs](http://wcdocs.woothemes.com/)
* [WooThemes Support](http://support.woothemes.com)