Set up a local 3.x environment

If you want to contribute to the Feedback module's 3.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 Feedback 3.x for development, and the add-ons needed to run lints and tests.

git clone --branch '3.x' git@git.drupal.org:project/feedback.git
cd feedback
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
ddev reset-test-env

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.

The following command installs dependencies, re-installs Drupal and Feedback, and displays a link you can use to log into the test site.

# Switch to the issue fork here

ddev reset-test-env

Before submitting code

Feedback 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