From 33ad36a8ec21ea67308fc715ed0d1f581faf12b8 Mon Sep 17 00:00:00 2001 From: sarahboyce Date: Tue, 27 Jun 2023 09:00:35 +0200 Subject: [PATCH] [5.0.x] Refs #34043 -- Clarified how to test UI changes. Backport of e083f3082c71853a01bf149bda7fdbaf58d25f4d from main --- docs/internals/contributing/writing-code/unit-tests.txt | 2 ++ docs/intro/contributing.txt | 9 +++++++-- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/internals/contributing/writing-code/unit-tests.txt b/docs/internals/contributing/writing-code/unit-tests.txt index 2835520a69..4f5cbeb125 100644 --- a/docs/internals/contributing/writing-code/unit-tests.txt +++ b/docs/internals/contributing/writing-code/unit-tests.txt @@ -247,6 +247,8 @@ Note that the ``--reverse`` option doesn't impact on ``--start-at`` or ``--start-after`` options. Moreover these options cannot be used with test labels. +.. _running-selenium-tests: + Running the Selenium tests -------------------------- diff --git a/docs/intro/contributing.txt b/docs/intro/contributing.txt index c9b5734569..652bca0cb2 100644 --- a/docs/intro/contributing.txt +++ b/docs/intro/contributing.txt @@ -188,7 +188,11 @@ have to create a new virtual environment, :ref:`install the previously cloned local copy of Django in editable mode `, and create a new Django project outside of your local copy of Django. You will immediately see any changes you make to Django in your new project, which is -of great help when writing your first patch. +of great help when writing your first patch, especially if testing any changes +to the UI. + +You can follow the :doc:`tutorial` for help in creating a +Django project. Running Django's test suite for the first time ============================================== @@ -259,7 +263,8 @@ __ https://djangoci.com For this tutorial and the ticket we're working on, testing against SQLite is sufficient, however, it's possible (and sometimes necessary) to :ref:`run the tests using a different database - `. + `. When making UI changes, you will need to + :ref:`run the Selenium tests `. Working on a feature ====================