* [PATCH] Adding testing information to CONTRIBUTE
2015-03-05 19:31 ` Samer Masterson
@ 2015-03-15 7:49 ` Samer Masterson
2015-03-15 17:39 ` Eli Zaretskii
0 siblings, 1 reply; 4+ messages in thread
From: Samer Masterson @ 2015-03-15 7:49 UTC (permalink / raw
To: Eli Zaretskii; +Cc: stephen_leake, emacs-devel
[-- 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 --]
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH] Adding testing information to CONTRIBUTE
2015-03-15 7:49 ` [PATCH] " Samer Masterson
@ 2015-03-15 17:39 ` Eli Zaretskii
0 siblings, 0 replies; 4+ messages in thread
From: Eli Zaretskii @ 2015-03-15 17:39 UTC (permalink / raw
To: Samer Masterson; +Cc: stephen_leake, emacs-devel
> Date: Sun, 15 Mar 2015 00:49:47 -0700
> From: Samer Masterson <samer@samertm.com>
> Cc: stephen_leake@stephe-leake.org, emacs-devel@gnu.org
>
> The patch below adds testing information to Emacs ("make check", the
> "test/automated" directory & make commands)
Thanks. This looks good to me, but please leave 2 spaces between
sentences, per the US English conventions we use in our documentation
project-wide.
> +2015-03-15 Samer Masterson <samer@samertm.com>
> +
> + * CONTRIBUTE (Test your changes.): Add section.
^^^^^^^^^^^
Nitpicking: we prefer "New section".
Thanks again for working on tyhis.
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] Adding testing information to CONTRIBUTE
@ 2015-03-15 17:47 Samer Masterson
2015-03-21 10:10 ` Eli Zaretskii
0 siblings, 1 reply; 4+ messages in thread
From: Samer Masterson @ 2015-03-15 17:47 UTC (permalink / raw
To: Eli Zaretskii; +Cc: stephen_leake, emacs-devel
I've made those changes. Thanks for reviewing this patch.
Best,
Samer Masterson
Patch below:
* CONTRIBUTE (Test your changes.): New section.
(Document your changes.): Add doc tips.
---
CONTRIBUTE | 20 ++++++++++++++++++++
ChangeLog | 5 +++++
2 files changed, 25 insertions(+)
diff --git a/CONTRIBUTE b/CONTRIBUTE
index 5cf015f..7c40227 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,
diff --git a/ChangeLog b/ChangeLog
index 4f6523e..76a633e 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2015-03-15 Samer Masterson <samer@samertm.com>
+
+ * CONTRIBUTE (Test your changes.): New 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
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH] Adding testing information to CONTRIBUTE
2015-03-15 17:47 [PATCH] Adding testing information to CONTRIBUTE Samer Masterson
@ 2015-03-21 10:10 ` Eli Zaretskii
0 siblings, 0 replies; 4+ messages in thread
From: Eli Zaretskii @ 2015-03-21 10:10 UTC (permalink / raw
To: Samer Masterson; +Cc: stephen_leake, emacs-devel
> From: Samer Masterson <samer@samertm.com>
> Date: Sun, 15 Mar 2015 10:47:00 -0700
> Cc: stephen_leake@stephe-leake.org, emacs-devel@gnu.org
>
> I've made those changes. Thanks for reviewing this patch.
Thanks, pushed.
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2015-03-21 10:10 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2015-03-15 17:47 [PATCH] Adding testing information to CONTRIBUTE Samer Masterson
2015-03-21 10:10 ` Eli Zaretskii
-- strict thread matches above, loose matches on Subject: below --
2015-03-05 11:02 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 ` [PATCH] " Samer Masterson
2015-03-15 17:39 ` Eli Zaretskii
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.