[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH] Adding testing information to CONTRIBUTE

From: Samer Masterson
Subject: [PATCH] Adding testing information to CONTRIBUTE
Date: Sun, 15 Mar 2015 00:49:47 -0700

The patch below adds testing information to Emacs ("make check", the
"test/automated" directory & make commands)

Samer Masterson

Patch below:

[PATCH] Add "Test your changes" and doc tips

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

 CONTRIBUTE | 20 ++++++++++++++++++++
 ChangeLog  |  5 +++++
 2 files changed, 25 insertions(+)

index 5cf015f..b9ece74 100644
@@ -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
+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
+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.in" 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 4f6523e..f5db1c5 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2015-03-15  Samer Masterson  <address@hidden>
+ * CONTRIBUTE (Test your changes.): Add section.
+ (Document your changes.): Add doc tips.
 2015-03-02  Robert Pluim  <address@hidden>  (tiny change)
  * configure.ac: Error out if with-file-notification=w32 is

reply via email to

[Prev in Thread] Current Thread [Next in Thread]