Welcome to the Yoast SEO GitHub repository
Want to contribute to Yoast SEO?
At Yoast, we make use a specific toolset to develop our code. Please ensure you have the following tools installed before contributing.
After installing the aforementioned tools, you can use the steps below to acquire a development version of Yoast SEO. Please note that this will download the latest development version of Yoast SEO. While this version is usually stable, it is not recommended for use in a production environment.
Within your WordPress installation, navigate to
wp-content/plugins and run the following commands:
git clone https://github.com/Yoast/wordpress-seo.git cd wordpress-seo
To install all the necessary dependencies, run the following commands:
composer install yarn grunt build
During development, you could run
grunt build:dev instead of
grunt build, to save yourself downloading some dependencies that are only needed for a production environment.
grunt build:js or
grunt build:css, respectively.
For active development, you could run
grunt watch to keep the build up-to-date and run checks right away.
define( 'YOAST_SEO_DEV_SERVER', true );
and you can start it by running
yarn start in the
grunt webpack:watch, this command will keep the JS files up-to-date. You'll have to refresh the page yourself since this does not run a development server.
This repository uses the Yoast grunt tasks plugin.
You can now modify the code of the linked packages directly from the
node_modules (as they're now symlinked to your
grunt build:js from the
wordpress-seo directory after making changes in order to apply those changes to the plugin.
yarn unlink-monorepo grunt build
This is a developer's portal for Yoast SEO and should not be used for support. Please visit the support forums.
It may help us a lot if you can provide a backtrace of the error encountered. You can use code in this gist to enable the backtrace in your website's configuration.
Anyone is welcome to contribute to Yoast SEO. Please read the guidelines for contributing to this repository.
There are various ways you can contribute: