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

This commit is contained in:
Michael Albinus 2025-01-28 10:12:09 +01:00
parent a9cde2463a
commit e74efd9a42

View 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)". 'ert-deftest' definition with ":tags '(:expensive-test)".
To run tests on the entire Emacs tree, run "make check" from the To run tests on the entire Emacs tree, run "make check" from the
top-level directory. Most tests are in the directory "test/". From top-level directory. Most tests are in the directory "test/". From the
the "test/" directory, run "make <filename>" to run the tests for "test/" directory, run "make <filename>-tests" to run the tests for
<filename>.el(c). See "test/README" for more information. <filename>.el(c). See "test/README" for more information.
If you're making changes that involve the Emacs build system, please 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 ../path-to-emacs-sources/configure
make 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 ** Commit messages
Ordinarily, a changeset you commit should contain a description of the Ordinarily, a changeset you commit should contain a description of the