summaryrefslogtreecommitdiff
path: root/CONTRIBUTE
diff options
context:
space:
mode:
authorSamer Masterson <samer@samertm.com>2015-03-21 12:09:30 +0200
committerEli Zaretskii <eliz@gnu.org>2015-03-21 12:09:30 +0200
commit70565a21765ea5f9b163e1a0ef1331df03c7fc67 (patch)
tree19ce3343f012bbc159341926ca96a85152fbdfa4 /CONTRIBUTE
parentfa734d07ab9dd00ad29d68668ed25247c9000aef (diff)
downloademacs-70565a21765ea5f9b163e1a0ef1331df03c7fc67.tar.gz
Documentation and testing tips for CONTRIBUTE
CONTRIBUTE (Test your changes.): New section. (Document your changes.): Add doc tips.
Diffstat (limited to 'CONTRIBUTE')
-rw-r--r--CONTRIBUTE20
1 files changed, 20 insertions, 0 deletions
diff --git a/CONTRIBUTE b/CONTRIBUTE
index 5cf015fe11a..7c40227b6d9 100644
--- a/CONTRIBUTE
+++ b/CONTRIBUTE
@@ -187,6 +187,26 @@ know it does not, mark the NEWS entry with "---". If you know
that *all* the necessary documentation updates have been made, mark
the entry with "+++". Otherwise do not mark it.
+Please see (info "(elisp)Documentation Tips") or
+https://www.gnu.org/software/emacs/manual/html_node/elisp/Documentation-Tips.html
+for more specific tips on Emacs's doc style. Use `checkdoc' to check
+for documentation errors before submitting a patch.
+
+** Test your changes.
+
+Please test your changes before committing them or sending them to the
+list.
+
+Emacs uses ERT, Emacs Lisp Regression Testing, for testing. See (info
+"(ert)") or https://www.gnu.org/software/emacs/manual/html_node/ert/
+for more information on writing and running tests.
+
+To run tests on the entire Emacs tree, run "make check" from the
+top-level directory. Most tests are in the directory
+"test/automated". From the "test/automated" directory, run "make
+<filename>" to run the tests for <filename>.el(c). See
+"test/automated/Makefile" for more information.
+
** Understanding Emacs Internals.
The best way to understand Emacs Internals is to read the code,