* Adding testing information to CONTRIBUTE
@ 2015-03-05 11:02 Samer Masterson
2015-03-05 14:14 ` Samer Masterson
2015-03-05 16:41 ` Eli Zaretskii
0 siblings, 2 replies; 8+ messages in thread
From: Samer Masterson @ 2015-03-05 11:02 UTC (permalink / raw)
To: Emacs developers; +Cc: stephen_leake
[-- Attachment #1: Type: text/plain, Size: 751 bytes --]
Hey list,
As a new contributor, I have no idea how to run or write tests for
Emacs, which means I end up testing my patches manually and miss bugs.
I could try to learn how Emacs uses tests on my own, but it would
benefit future new contributors if we added a section on testing to
CONTRIBUTE.
Here is what I would want to see:
- How to write tests, with a pointer to an internal Emacs package that
has idiomatic and comprehensive tests.
- How to run tests on the entire tree and on individual files.
- A pointer to an info page on the testing framework/pattern that most
internal Emacs packages use.
Would anyone be interested in working on this? cc'ing Stephen Leake
because he lead the most recent major changes to CONTRIBUTE.
-samer
[-- Attachment #2: Type: text/html, Size: 886 bytes --]
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: Adding testing information to CONTRIBUTE
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 16:41 ` Eli Zaretskii
1 sibling, 1 reply; 8+ messages in thread
From: Samer Masterson @ 2015-03-05 14:14 UTC (permalink / raw)
To: Emacs developers; +Cc: stephen_leake
[-- Attachment #1: Type: text/plain, Size: 938 bytes --]
I just learned about checkdoc, and it should probably be mentioned too.
On Thu, Mar 5, 2015 at 3:02 AM, Samer Masterson <samer@samertm.com>
wrote:
> Hey list,
>
> As a new contributor, I have no idea how to run or write tests for
> Emacs, which means I end up testing my patches manually and miss
> bugs. I could try to learn how Emacs uses tests on my own, but it
> would benefit future new contributors if we added a section on
> testing to CONTRIBUTE.
>
> Here is what I would want to see:
> - How to write tests, with a pointer to an internal Emacs package
> that has idiomatic and comprehensive tests.
> - How to run tests on the entire tree and on individual files.
> - A pointer to an info page on the testing framework/pattern that
> most internal Emacs packages use.
>
> Would anyone be interested in working on this? cc'ing Stephen Leake
> because he lead the most recent major changes to CONTRIBUTE.
>
> -samer
[-- Attachment #2: Type: text/html, Size: 1094 bytes --]
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: Adding testing information to CONTRIBUTE
2015-03-05 11:02 Adding testing information to CONTRIBUTE Samer Masterson
2015-03-05 14:14 ` Samer Masterson
@ 2015-03-05 16:41 ` Eli Zaretskii
2015-03-05 19:25 ` Samer Masterson
1 sibling, 1 reply; 8+ messages in thread
From: Eli Zaretskii @ 2015-03-05 16:41 UTC (permalink / raw)
To: Samer Masterson; +Cc: stephen_leake, emacs-devel
> Date: Thu, 05 Mar 2015 03:02:26 -0800
> From: Samer Masterson <samer@samertm.com>
> Cc: stephen_leake@stephe-leake.org
>
> As a new contributor, I have no idea how to run or write tests for Emacs, which
> means I end up testing my patches manually and miss bugs. I could try to learn
> how Emacs uses tests on my own, but it would benefit future new contributors if
> we added a section on testing to CONTRIBUTE.
>
> Here is what I would want to see:
> - How to write tests, with a pointer to an internal Emacs package that has
> idiomatic and comprehensive tests.
> - How to run tests on the entire tree and on individual files.
> - A pointer to an info page on the testing framework/pattern that most internal
> Emacs packages use.
Most of this is described in ert.info, which I presume you've read.
I agree that CONTRIBUTE should mention that manual (right near the
place that it mentions "Tips" and "GNU Emacs Internals").
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: Adding testing information to CONTRIBUTE
2015-03-05 14:14 ` Samer Masterson
@ 2015-03-05 16:47 ` Eli Zaretskii
2015-03-05 19:31 ` Samer Masterson
0 siblings, 1 reply; 8+ messages in thread
From: Eli Zaretskii @ 2015-03-05 16:47 UTC (permalink / raw)
To: Samer Masterson; +Cc: stephen_leake, emacs-devel
> Date: Thu, 05 Mar 2015 06:14:20 -0800
> From: Samer Masterson <samer@samertm.com>
> Cc: stephen_leake@stephe-leake.org
>
> I just learned about checkdoc, and it should probably be mentioned too.
It's mentioned in "Tips for Documentation Strings", to whose parent
node CONTRIBUTE already points.
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: Adding testing information to CONTRIBUTE
2015-03-05 16:41 ` Eli Zaretskii
@ 2015-03-05 19:25 ` Samer Masterson
0 siblings, 0 replies; 8+ messages in thread
From: Samer Masterson @ 2015-03-05 19:25 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: stephen_leake, emacs-devel
[-- Attachment #1: Type: text/plain, Size: 261 bytes --]
On Thu, Mar 5, 2015 at 8:41 AM, Eli Zaretskii <eliz@gnu.org> wrote:
> I agree that CONTRIBUTE should mention that manual (right near the
> place that it mentions "Tips" and "GNU Emacs Internals").
Okay, I can write something up and send the patch to the list.
[-- Attachment #2: Type: text/html, Size: 375 bytes --]
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: Adding testing information to CONTRIBUTE
2015-03-05 16:47 ` Eli Zaretskii
@ 2015-03-05 19:31 ` Samer Masterson
2015-03-15 7:49 ` [PATCH] " Samer Masterson
0 siblings, 1 reply; 8+ messages in thread
From: Samer Masterson @ 2015-03-05 19:31 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: stephen_leake, emacs-devel
[-- Attachment #1: Type: text/plain, Size: 587 bytes --]
On Thu, Mar 5, 2015 at 8:47 AM, Eli Zaretskii <eliz@gnu.org> wrote:
>> Date: Thu, 05 Mar 2015 06:14:20 -0800
>> From: Samer Masterson <samer@samertm.com>
>> Cc: stephen_leake@stephe-leake.org
>>
>> I just learned about checkdoc, and it should probably be mentioned
>> too.
>
> It's mentioned in "Tips for Documentation Strings", to whose parent
> node CONTRIBUTE already points.
I think it would be useful if checkdoc and "Tips for Documentation
Strings" were mentioned under "Documenting your changes". Assuming
there are no objections, I can roll that into the testing patch.
[-- Attachment #2: Type: text/html, Size: 788 bytes --]
^ permalink raw reply [flat|nested] 8+ messages in thread
* [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; 8+ 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] 8+ 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; 8+ 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] 8+ messages in thread
end of thread, other threads:[~2015-03-15 17:39 UTC | newest]
Thread overview: 8+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
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 ` [PATCH] " Samer Masterson
2015-03-15 17:39 ` Eli Zaretskii
2015-03-05 16:41 ` Eli Zaretskii
2015-03-05 19:25 ` Samer Masterson
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).