* CONTRIBUTE: Recommend running the unit test prior to committing.
authorMichael Albinus <michael.albinus@gmx.de>
Tue, 28 Jan 2025 09:12:09 +0000 (10:12 +0100)
committerMichael Albinus <michael.albinus@gmx.de>
Tue, 28 Jan 2025 09:12:09 +0000 (10:12 +0100)
CONTRIBUTE

index e03674e5d14de3ad4c992c4ee169696edfbdb9bf..2b5c438c055e1c62dfcf0093c5170cebaa0ebacf 100644 (file)
@@ -157,8 +157,8 @@ If your test lasts longer than some few seconds, mark it in its
 'ert-deftest' definition with ":tags '(:expensive-test)".
 
 To run tests on the entire Emacs tree, run "make check" from the
-top-level directory.  Most tests are in the directory "test/".  From
-the "test/" directory, run "make <filename>" to run the tests for
+top-level directory.  Most tests are in the directory "test/".  From the
+"test/" directory, run "make <filename>-tests" to run the tests for
 <filename>.el(c).  See "test/README" for more information.
 
 If you're making changes that involve the Emacs build system, please
@@ -169,6 +169,12 @@ test 'out-of-tree' builds as well, i.e.:
     ../path-to-emacs-sources/configure
     make
 
+It is a good practice to run the unit test of a change prior to committing.
+If you have changed, e.g., the file "xt-mouse.el", you can run the unit
+tests via
+
+    make && make -C test xt-mouse-tests
+
 ** Commit messages
 
 Ordinarily, a changeset you commit should contain a description of the