CONTRIBUTING.md
| 1 | # Want to contribute? |
| 2 | |
| 3 | Did you know that you could be instrumental in making Jetpack more robust and secure? If you use and love Jetpack, why not contribute to the project? |
| 4 | |
| 5 | ## Contributing for Everyone! |
| 6 | |
| 7 | Whether you can barely recognize a filter (or don’t know what that means) or you’ve already authored your own plugins, there are ways for you to pitch in. |
| 8 | |
| 9 | ### Beta Testing |
| 10 | |
| 11 | Beta testers give updates, fixes, and new modules a test run before they’re publicly released, so they’re an important part of the development process. If you'd like to join our Beta group, [](http://jetpack.me/contact-support/contact us](http://jetpack.me/contact-support/](http://jetpack.me/contact-support/)! |
| 12 | |
| 13 | ### Create Bug Reports |
| 14 | |
| 15 | If you find a bug, let us know by creating a new issue [](https://github.com/Automattic/jetpack/issues/newhere](https://github.com/Automattic/jetpack/issues/new](https://github.com/Automattic/jetpack/issues/new). You can [](http://jetpack.me/contribute/#bugscheck our recommendations to create great bug reports here](http://jetpack.me/contribute/#bugs](http://jetpack.me/contribute/#bugs). |
| 16 | |
| 17 | ### Write and submit a patch |
| 18 | |
| 19 | If you'd like to fix a bug, you can submit a Pull Request. [](http://jetpack.me/contribute/#patchFollow these detailed steps to find out how](http://jetpack.me/contribute/#patch](http://jetpack.me/contribute/#patch). |
| 20 | |
| 21 | When creating Pull Requests, remember: |
| 22 | |
| 23 | - [](http://blog.codinghorror.com/check-in-early-check-in-often/Check In Early, Check In Often](http://blog.codinghorror.com/check-in-early-check-in-often/](http://blog.codinghorror.com/check-in-early-check-in-often/). |
| 24 | - Write [](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.htmlgood commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). |
| 25 | - Respect the [](http://jetpack.me/contribute/#practicesBest practices for WordPress development](http://jetpack.me/contribute/#practices](http://jetpack.me/contribute/#practices). |
| 26 | |
| 27 | There are a few bonuses that can increase the chances that your Pull Request is accepted: |
| 28 | |
| 29 | - If you've created a new action or filter, [](https://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/#4-hooks-actions-and-filtersadd inline documentation](https://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/#4-hooks-actions-and-filters](https://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/#4-hooks-actions-and-filters) to help others understand how to use the action or the filter. |
| 30 | - Create [](https://github.com/Automattic/jetpack/tree/master/testsunit tests](https://github.com/Automattic/jetpack/tree/master/tests](https://github.com/Automattic/jetpack/tree/master/tests) if you can. If you're not familiar with Unit Testing, you can check [](https://pippinsplugins.com/series/unit-tests-wordpress-plugins/this tutorial](https://pippinsplugins.com/series/unit-tests-wordpress-plugins/](https://pippinsplugins.com/series/unit-tests-wordpress-plugins/). |
| 31 | - If [](http://gruntjs.com/Grunt](http://gruntjs.com/](http://gruntjs.com/) is installed on your testing environmenent, run it after committing your changes. It will allow you to [](http://jshint.com/about/detect errors in Javascript files](http://jshint.com/about/](http://jshint.com/about/), compile Sass to CSS, and [](https://github.com/Automattic/jetpack/blob/master/Gruntfile.jsa few other things](https://github.com/Automattic/jetpack/blob/master/Gruntfile.js](https://github.com/Automattic/jetpack/blob/master/Gruntfile.js). |
| 32 | |
| 33 | #### Where to get started? |
| 34 | |
| 35 | If you'd like to contribute but don't know where to get started, you can take a look at existing issues: |
| 36 | |
| 37 | - [](https://github.com/Automattic/Jetpack/issues?q=is%3Aopen+is%3Aissue+label%3A%22Good+First+Bug%22"Good First Bug"](https://github.com/Automattic/Jetpack/issues?q=is%3Aopen+is%3Aissue+label%3A%22Good+First+Bug%22](https://github.com/Automattic/Jetpack/issues?q=is%3Aopen+is%3Aissue+label%3A%22Good+First+Bug%22) issues are a good entry point to get familiar with Jetpack's codebase. |
| 38 | - [](https://github.com/Automattic/jetpack/labels/Whisky%20Ticket"Whisky"](https://github.com/Automattic/jetpack/labels/Whisky%20Ticket](https://github.com/Automattic/jetpack/labels/Whisky%20Ticket) issues are important bugs or enhancements. Take a crack at it if you feel adventurous! :) |
| 39 |