From: Michael Albinus <michael.albinus@gmx.de>
Date: Tue, 28 Jan 2025 09:12:09 +0000 (+0100)
Subject: * CONTRIBUTE: Recommend running the unit test prior to committing.
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=dfdbc0fe69c90ae62f71fc50429198d651f3fc69;p=emacs.git

* CONTRIBUTE: Recommend running the unit test prior to committing.

(cherry picked from commit e74efd9a428491288be46ce56f1d6f4f7cf79ed9)
---

diff --git a/CONTRIBUTE b/CONTRIBUTE
index 936aa326e89..0465bdee9fc 100644
--- a/CONTRIBUTE
+++ b/CONTRIBUTE
@@ -160,8 +160,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
@@ -172,6 +172,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