Drupal CMS development repository

If you're here to report a bug in Drupal CMS, visit the issue queue.

Getting Started

To contribute to Drupal CMS, you'll need DDEV, which is our officially supported platform for contribution. Install it on your machine, then follow these instructions:

1. Follow the instructions to clone this repository.
2. At the command line, go into the repository root and run ddev launch.

Getting Help

Find us in the #drupal-cms-development channel in Drupal Slack.

Running Tests

Once the project's containers are up and running (run ddev start to ensure that), you can use the following commands to run Drupal CMS's tests:

# Runs all tests in all recipes.
ddev test

# Runs all tests in a single recipe.
ddev test recipes/NAME_OF_RECIPE

# Runs all end-to-end (Cypress) tests in all recipes.
ddev npm test

# Runs all end-to-end tests in a single recipe.
ddev npm test -- --spec="recipes/NAME_OF_RECIPE/tests/e2e/*.cy.js"

# Runs all PHPUnit tests in a single recipe.
ddev exec phpunit -c web/core recipes/NAME_OF_RECIPE

# Runs a single PHPUnit test.
ddev exec phpunit -c web/core path/to/test/file.php

# Runs Cypress with custom options.
ddev npm test -- CUSTOM_OPTIONS...

# Runs PHPUnit with custom options.
ddev exec phpunit CUSTOM_OPTIONS...

Reinstalling Drupal CMS

# To reinstall Drupal CMS:
ddev drush site:install --yes

# To reinstall Drupal CMS via the UI:
ddev drush sql:drop --yes
ddev launch

# To delete and reinstall all dependencies:
ddev rebuild

Applying a Recipe

ddev drush recipe ../recipes/NAME_OF_RECIPE