Set up a local 8.x-2.x environment

If you want to contribute to the Sitemap module's 8.x-2.x branch, this guide will help you set up a local environment for developing and testing the module.

Requirements

You will need a relatively modern computer that can run DDEV. The commands below assume that you are using a Bash-like shell for Linux, Mac, or Windows Subsystem for Linux.

One-time setup

The following commands set up Sitemap 8.x-2.x for development, and the add-ons needed to run lints and tests.

git clone --branch '8.x-2.x' git@git.drupal.org:project/sitemap.git
cd sitemap
ddev config --auto
ddev add-on get ddev/ddev-drupal-contrib
ddev add-on get ddev/ddev-selenium-standalone-chrome
ddev start
echo '$settings["extension_discovery_scan_tests"] = TRUE;' | tee -a web/sites/default/settings.php

Setup for working on an issue

When you start working on a new issue, it is often a good idea to re-install Drupal in your development environment. This way, your previous test content and configuration won't affect the results of your current work.

# Switch to the issue fork here

ddev poser
ddev exec "cd web/core && yarn install"
ddev symlink-project
ddev drush -y site:install minimal
ddev drush -y pm:install toolbar field_ui views_ui
ddev drush -y theme:install claro
ddev drush -y config:set system.theme admin claro
ddev drush -y pm:install sitemap sitemap_custom_plugin_test sitemap_vocabulary_api_test
ddev drush -y uli

Before submitting code

Sitemap runs a number of linters and automated tests in CI when you submit code. Running these linters and automated tests before you submit code will make it faster to easier for maintainers to review and accept your code!

ddev phpcs
ddev phpstan
ddev phpunit
ddev eslint
ddev stylelint