The details below will walk you through getting set up to contribute to the code behind https://learn.wordpress.org. If you are interested in contributing to the content or translation of the content hosted on the site, you'll find further guidance in the Training Team Handbook. Content development is tracked on this GitHub repository in this project board.
Looking to contribute to our project for Hacktoberfest 2023? You can read more details of how to contribute here.
yarnyarn run create- Visit site at
localhost:8888
run yarn run wp-env stop
run yarn run wp-env destroy
Since the local environment uses wp-env, it automatically comes with an admin user, with admin/password for the credentials.
While working on the theme & plugin, you might need to rebuild the CSS or JavaScript.
To build both projects, you can run:
yarn workspaces run build
To build one at a time, run
yarn workspace wporg-learn-theme build
yarn workspace wporg-learn-plugin build
If you want to watch for changes, run start. This can only be run in one project at a time:
yarn workspace wporg-learn-theme start
yarn workspace wporg-learn-plugin start
This project has eslint, stylelint, and phpcs set up for linting the code. This ensures all developers are working from the same style. To check your code before pushing it to the repo, run
yarn workspace wporg-learn-theme lint:css
yarn workspace wporg-learn-plugin lint:css
yarn workspace wporg-learn-plugin lint:js
composer run lint
These checks will also be run automatically on each PR.
If you'd like to contribute to the project, please read the code contribution guidelines in our team handbook.