summaryrefslogtreecommitdiff
path: root/CONTRIBUTE
diff options
context:
space:
mode:
authorMichael Albinus <michael.albinus@gmx.de>2025-01-28 10:12:09 +0100
committerMichael Albinus <michael.albinus@gmx.de>2025-01-28 10:12:09 +0100
commite74efd9a428491288be46ce56f1d6f4f7cf79ed9 (patch)
treeb38c799e6ad7c8a7226ec8dc5e7fb85cf87c3807 /CONTRIBUTE
parenta9cde2463abd6677e9d44d306473beef00983aad (diff)
* CONTRIBUTE: Recommend running the unit test prior to committing.
Diffstat (limited to 'CONTRIBUTE')
-rw-r--r--CONTRIBUTE10
1 files changed, 8 insertions, 2 deletions
diff --git a/CONTRIBUTE b/CONTRIBUTE
index e03674e5d14..2b5c438c055 100644
--- a/CONTRIBUTE
+++ b/CONTRIBUTE
@@ -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