Skip to content

Latest commit

 

History

History
45 lines (24 loc) · 3.22 KB

CONTRIBUTING.md

File metadata and controls

45 lines (24 loc) · 3.22 KB

Contributing to Jetpack

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

Developers of all levels can help — 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.

Beta Testing

We're always interested in hearing your feedback about existing and upcoming Jetpack features. The easiest way to help test Jetpack is to join our Beta group.

Create Bug Reports

If you find a bug, please file a GitHub issue. If you want to prefix the title with a “Question:”, “Bug:”, or the general area of the application, that would be helpful, but by no means mandatory. If you have write access, add the appropriate labels.

If you’re filing a bug, specific steps to reproduce are helpful. Please include the URL of the page that has the bug, along with what you expected to see and what happened instead. You can check our recommendations to create great bug reports here.

Write and submit a patch

If you'd like to fix a bug or make an enhancement, you can submit a Pull Request. Before you get started, you'll want to set up your development environment.

Once your development environment is ready, you can get started and create your first Pull Request!

Get started

If you'd like to contribute but don't know where to get started, you can take a look at existing issues:

  • "Good First Bug" issues are a good entry point to get familiar with Jetpack's code base.
  • All issues labeled with the "Good For Community" label are fair game. That's a great way to contribute new features and fix small issues within Jetpack.

We’re Here To Help

We encourage you to ask for help at any point. We want your first experience with Jetpack to be a good one, so don’t be shy. If you’re wondering why something is the way it is, or how a decision was made, you can create an issue and prefix it with “Question:”.

Translate the plugin

If you speak a foreign language, you can help translate Jetpack into your own language. here is how.

License

Jetpack is licensed under GNU General Public License v2 (or later).

All materials contributed should be compatible with the GPLv2. This means that if you own the material, you agree to license it under the GPLv2 license. If you are contributing code that is not your own, such as adding a component from another Open Source project, or adding an npm package, you need to make sure you follow these steps:

  1. Check that the code has a license. If you can't find one, you can try to contact the original author and get permission to use, or ask them to release under a compatible Open Source license.
  2. Check the license is compatible with GPLv2, note that the Apache 2.0 license is not compatible.