From 0dd3360e593c5e47fcd2bfda53bcfa007cefc044 Mon Sep 17 00:00:00 2001 From: Dennis Dornon Date: Mon, 24 Mar 2014 13:31:39 -0400 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6d933b6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# How to contribute + +Community made patches, localisations, bug reports and contributions are always welcome and are crucial to ensure MainWP's continued growth. + +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 customization don't post here. Use [MainWP Support Forum](https://mainwp.com/forum/) for cfor community support. + +## 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 [Dealing with line endings] (https://help.github.com/articles/dealing-with-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 branch of the MainWP repository. Existing maintenance branches will be maintained of by MainWP developers. +* Please don't modify the changelog, this will be maintained by MainWP developers. + +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](http://help.github.com/) +* [GitHub pull request documentation](http://help.github.com/send-pull-requests/) +* [MainWP Codex](http://codex.mainwp.com/) +* [MainWP Support](https://mainwp.com/forum/)