Skip to content
/ Learn Public
forked from WordPress/Learn

WordPress.org Learn - The canonical source for the code and content behind https://learn.WordPress.org

Notifications You must be signed in to change notification settings

westnz/Learn

 
 

Repository files navigation

WP - Learn WordPress

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.

Hacktoberfest 2023

Looking to contribute to our project for Hacktoberfest 2023? You can read more details of how to contribute here.

Prerequisites

Setup

  1. yarn
  2. yarn run create
  3. Visit site at localhost:8888

Stopping Environment

run yarn run wp-env stop

Removing Environment

run yarn run wp-env destroy

Admin

Since the local environment uses wp-env, it automatically comes with an admin user, with admin/password for the credentials.

Development

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

Linting

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.

Contributing

If you'd like to contribute to the project, please read the code contribution guidelines in our team handbook.

About

WordPress.org Learn - The canonical source for the code and content behind https://learn.WordPress.org

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 67.6%
  • JavaScript 25.3%
  • SCSS 6.2%
  • Other 0.9%