This is the Jetpack Monorepo. It contains source code for the different Jetpack plugins, Composer and JavaScript packages used by the plugins, and other things.
If you are not planning on developing with Jetpack, you should install Jetpack from pre-built sources. Details on that may be found on this page.
If you're interested in developing with the Jetpack monorepo, you can check out the Quick Start Guide here.
To run the Jetpack plugin from the monorepo, you'll first need to build it. To do so, follow the instructions here.
If you're using the Docker development environment, you should then be all set.
If not, you'll need to create a link to the Jetpack plugin from your WordPress wp-content/plugins folder (you cannot clone the monorepo into your WordPress plugins directory - you will see a warning on your plugins page if so saying that the Jetpack Monorepo is not a plugin and shouldn't be installed as one). You'll need to know the filesystem path to the monorepo checkout and to your WordPress installation. Then, on Linux or Mac OS X, open a terminal and use ln -s to create the link, something like
ln -s /path/to/jetpack-monorepo/projects/plugins/jetpack /path/to/wordpress/wp-content/plugins/jetpack
On Windows (Vista and later), open an Administrator Command Prompt window and use mklink /D similarly.
Thank you for thinking about contributing to Jetpack! If you're unsure of anything, feel free to submit an issue or pull request on any topic. The worst that can happen is that you'll be politely directed to the best location to ask your question or to change something in your pull request. There are a variety of options for how you can help:
- Write and submit patches.
- If you found a bug, file a report here. You can check our recommendations to create great bug reports here.
- Join our Jetpack Beta program and help us test new releases.
- Translate Jetpack in your language.
To clarify these expectations, Jetpack has adopted the code of conduct defined by the Contributor Covenant. It can be read in full here.
Need to report a security vulnerability? Go to https://automattic.com/security/ or directly to our security bug bounty site https://hackerone.com/automattic.
Jetpack is licensed under GNU General Public License v2 (or later).
Interested in working on awesome open-source code all day? Join us!
