Skip to content

Latest commit

 

History

History
61 lines (34 loc) · 4.52 KB

readme.md

File metadata and controls

61 lines (34 loc) · 4.52 KB

Jetpack Monorepo

License codecov

This is the Jetpack Monorepo. It contains source code for the Jetpack plugin, the Jetpack composer packages, and other things.

How to install Jetpack plugin on your site

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.

Developing from the Monorepo

If you're interested in developing with the Jetpack monorepo, you can check out the Quick Start Guide here.

Installation From Git Monorepo

To run the Jetpack plugin from the monorepo, you'll first need to build the JS and CSS. 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.

Contribute

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:

To clarify these expectations, Jetpack has adopted the code of conduct defined by the Contributor Covenant. It can be read in full here.

Security

Need to report a security vulnerability? Go to https://automattic.com/security/ or directly to our security bug bounty site https://hackerone.com/automattic.

License

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

Team

Jetpack is developed and maintained by various teams at Automattic. The Jetpack Crew responsible for coordinating everything is comprised of @adimoldovan, @anomiex, @bindlegirl, @bisko, @brbrr, @briancolinger, @coder-karen, @dereksmart, @fgiannar, @jeherve, @kbrown9, @kraftbj, @leogermani, @mdbitz, @samiff, @sdixon194, @sergeymitr, and @zinigor.

Contributions have been and continue to be made by dozens of other Automatticians, like:

@aldavigdis, @allendav, @apeatling, @azaozz, @bazza, @beaulebens, @cfinke, @daniloercoli, @chaosexanima, @ebinnion, @enejb, @eoigal, @georgestephanis, @gibrown, @gititon, @gravityrail, @jasmussen, @jblz, @jeffgolenski, @jessefriedman, @joanrho, @justinshreve, @keoshi, @koke, @kovshenin, @lancewillett, @lezama, @martinremy, @mdawaffe, @MichaelArestad, @mtias, @mcsf, @mdawaffe, @nickmomrik, @obenland, @oskosk, @pento, @roccotripaldi, @stephdau, @Viper007Bond, @xyu, and @yoavf.

Our awesome Happiness Engineers are @a8ck3n, @aicee, @bizanimesh, @brucea8c, @cena, @danjjohnson, @dericleeyy, @dkmyta, @gaurav1984, @jenhooks, @JenSwish, @julsyd, @kristinaplauche, @lizthefair, @madhattermattic, @mbhthompson, @mzakariya, @pranali333, @rcowles, @snowmads, @stefmattana, and @tmmbecker.

Interested in working on awesome open-source code all day? Join us!