From: Samer Masterson <samer@samertm.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: stephen_leake@stephe-leake.org, emacs-devel@gnu.org
Subject: [PATCH] Adding testing information to CONTRIBUTE
Date: Sun, 15 Mar 2015 00:49:47 -0700 [thread overview]
Message-ID: <1426405787.4214.1@mail.samertm.com> (raw)
In-Reply-To: <1425583915.22241.2@mail.samertm.com>
[-- Attachment #1: Type: text/plain, Size: 2034 bytes --]
The patch below adds testing information to Emacs ("make check", the
"test/automated" directory & make commands)
Best,
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(+)
diff --git a/CONTRIBUTE b/CONTRIBUTE
index 5cf015f..b9ece74 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.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 <samer@samertm.com>
+
+ * CONTRIBUTE (Test your changes.): Add section.
+ (Document your changes.): Add doc tips.
+
2015-03-02 Robert Pluim <rpluim@gmail.com> (tiny change)
* configure.ac: Error out if with-file-notification=w32 is
[-- Attachment #2: Type: text/html, Size: 3155 bytes --]
next prev parent reply other threads:[~2015-03-15 7:49 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-03-05 11:02 Adding testing information to CONTRIBUTE Samer Masterson
2015-03-05 14:14 ` Samer Masterson
2015-03-05 16:47 ` Eli Zaretskii
2015-03-05 19:31 ` Samer Masterson
2015-03-15 7:49 ` Samer Masterson [this message]
2015-03-15 17:39 ` [PATCH] " Eli Zaretskii
2015-03-05 16:41 ` Eli Zaretskii
2015-03-05 19:25 ` Samer Masterson
-- strict thread matches above, loose matches on Subject: below --
2015-03-15 17:47 [PATCH] " Samer Masterson
2015-03-21 10:10 ` Eli Zaretskii
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1426405787.4214.1@mail.samertm.com \
--to=samer@samertm.com \
--cc=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=stephen_leake@stephe-leake.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.