Documentation and testing tips for CONTRIBUTE

 CONTRIBUTE (Test your changes.): New section.
 (Document your changes.): Add doc tips.

diff --git a/CONTRIBUTE b/CONTRIBUTE
index 5cf015fe11a84d7d4f656f08880023a7d0181465..7c40227b6d91988f34ae67aff1a2ab23257e8cc1 100644 (file)
--- 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,

diff --git a/ChangeLog b/ChangeLog
index a79863a839eca0c6ca2ad9cfc3308091d5653c69..c155708f1f4bb64d739362a3b80c652b50c7296b 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2015-03-21  Samer Masterson  <samer@samertm.com>
+
+       * CONTRIBUTE (Test your changes.): New section.
+       (Document your changes.): Add doc tips.
+
 2015-03-19  Paul Eggert  <eggert@cs.ucla.edu>
 
        Better port of pthread usage to FreeBSD