Go to file
Jonathan Desrosiers addf14cf98 Tag 5.4.2
git-svn-id: https://develop.svn.wordpress.org/tags/5.4.2@48007 602fd350-edb4-49c9-b593-d223f7449a82
2020-06-10 21:40:13 +00:00
.github General: Introduce a pull request template. 2020-02-21 18:23:28 +00:00
src WordPress 5.4.2. 2020-06-10 21:30:59 +00:00
tests Editor: Ensure latest comments can only be viewed from public posts. 2020-06-10 19:21:12 +00:00
tools Scripts: Use core-js url as polyfill for window.URL. 2020-03-03 16:53:32 +00:00
.editorconfig General: Instruct file editors not to trim trailing whitespace in markdown files. 2018-03-20 22:14:53 +00:00
.env Docs: Fix typo in `.env` file description. 2019-12-30 13:46:17 +00:00
.gitignore Build Tools: 2020-02-24 21:20:49 +00:00
.jshintrc Build tools: Fix the `travis:js` build. 2018-12-24 13:53:11 +00:00
.npmrc Once upon a midnight dreary, while I coded, weak and weary, 2018-05-23 10:04:22 +00:00
.nvmrc Once upon a midnight dreary, while I coded, weak and weary, 2018-05-23 10:04:22 +00:00
.travis.yml Tests: Download Chromium for e2e tests only. 2020-03-16 12:26:00 +00:00
Gruntfile.js Build Tools: Exclude the `src/wp-includes/assets/` directory from copying when building. Its content is generated by Webpack and copied in another task. 2020-03-02 19:08:48 +00:00
README.md Docs: Fix typo in `README.md`. 2019-11-20 08:31:32 +00:00
SECURITY.md Security: Add WordPress 5.3.x to the "Supported Versions" section of GitHub Security Policy. 2019-11-16 11:17:42 +00:00
appveyor.yml Build/Test Tools: Remove the dependency on a globally installed Grunt. 2019-05-26 19:34:24 +00:00
composer.json Coding Standards: Update PHPCS Composer plugin to v0.6.0. 2020-02-28 01:38:58 +00:00
composer.lock Build/Test Tools: Introduce automated PHP compatibility checking. 2019-09-25 13:46:55 +00:00
docker-compose.yml Build/Test Tools: Expose port 3306 of MySQL container. 2020-02-09 21:20:25 +00:00
jsdoc.conf.json Build Tools: Fix JSDoc configuration include paths. 2018-06-14 12:45:06 +00:00
package-lock.json The 5.4 branch is now WordPress 5.4.2 alpha 2020-04-29 20:01:40 +00:00
package.json Build/Test Tools: Introduce a command for restarting the local Docker environment. 2020-05-01 12:59:06 +00:00
phpcompat.xml.dist Docs: Improve inline comments per the documentation standards. 2020-01-29 00:43:23 +00:00
phpcs.xml.dist Coding Standards: Adjust coding standards to always omit parentheses for `include`/`require` statements. 2020-02-07 19:14:29 +00:00
phpunit.xml.dist Docs: Improve inline comments per the documentation standards. 2020-01-29 00:43:23 +00:00
webpack.config.js Build tools: Allow building WordPress to `src`. 2018-12-24 13:28:22 +00:00
wp-cli.yml Build/Tests: Default to running unit tests from `src`. 2019-01-09 10:09:02 +00:00
wp-config-sample.php Code Modernization: Replace `dirname( __FILE__ )` calls with `__DIR__` magic constant. 2020-02-06 06:31:22 +00:00
wp-tests-config-sample.php Tests: Revert the `dirname( __FILE__ )` replacement in `wp-tests-config-sample.php` for now, to avoid breaking unit tests created with WP-CLI `scaffold` command. 2020-02-06 21:49:13 +00:00

README.md

WordPress

Build Status

Welcome to the WordPress development repository! Please check out our contributor handbook for information about how to open bug reports, contribute patches, test, documentation, or get involved in any way you can.

Getting Started

WordPress is a PHP/MySQL-based project. We have a basic development environment that you can quickly get up and running with a few commands. First off, you will need to download and install Docker, if you don't have it already. After that, there are a few commands to run:

Development Environment Commands

Running these commands will start the development environment:

npm install
npm run build:dev
npm run env:start
npm run env:install

Additionally, npm run env:stop will stop the environment.

npm run env:cli runs the WP-CLI tool. WP-CLI has a lot of useful commands you can use to work on your WordPress site. Where the documentation mentions running wp, run npm run env:cli instead. For example, npm run env:cli help.

npm run test:php and npm run test:e2e run the PHP and E2E test suites, respectively.