From: "Przemysław Wojnowski" <esperanto@cumego.com>
To: Emacs Developers <emacs-devel@gnu.org>
Subject: [PATCH] CONTRIBUTE - writing tests for understanding internals
Date: Tue, 10 Nov 2015 23:48:41 +0100 [thread overview]
Message-ID: <87twotqxme.fsf@cumego.com> (raw)
[-- Attachment #1: Type: text/plain, Size: 269 bytes --]
Hello everybody,
Here's a small patch that adds to CONTRIBUTE that writing tests is a
great way to learn about Emacs Internals, takes a new contributor
through committing process and is valuable to the project.
Please, check if that has been written in English. :-)
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: writing tests to understand internals --]
[-- Type: text/x-diff, Size: 1554 bytes --]
From 6d59909ba6166b0d19a2d690caec52387280e2e7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Przemys=C5=82aw=20Wojnowski?= <esperanto@cumego.com>
Date: Tue, 10 Nov 2015 23:34:01 +0100
Subject: [PATCH] ; * CONTRIBUTE: Add testing to understanding Emacs Internals.
* CONTRIBUTE: Point that writing tests teaches about Emacs Internals and
brings value to the project itself.
---
CONTRIBUTE | 15 ++++++++++-----
1 file changed, 10 insertions(+), 5 deletions(-)
diff --git a/CONTRIBUTE b/CONTRIBUTE
index 2aae251..807e7a3 100644
--- a/CONTRIBUTE
+++ b/CONTRIBUTE
@@ -264,11 +264,16 @@ top-level directory. Most tests are in the directory
** Understanding Emacs Internals.
-The best way to understand Emacs Internals is to read the code,
-but the nodes "Tips" and "GNU Emacs Internals" in the Appendix
-of the Emacs Lisp Reference Manual may also help. Some source files,
-such as xdisp.c, have large commentaries describing the design and
-implementation in more detail.
+There are at least two good ways to understand Emacs Internal.
+
+One of them is to read the code, but the nodes "Tips" and "GNU Emacs
+Internals" in the Appendix of the Emacs Lisp Reference Manual may also
+help. Some source files, such as xdisp.c, have large commentaries
+describing the design and implementation in more detail.
+
+Another way into Emacs Internal is to write tests. This one is more
+fun, takes you through Emacs contribution process and increases
+Emacs test coverage! Don't think twice!
The file etc/DEBUG describes how to debug Emacs bugs.
--
2.1.4
next reply other threads:[~2015-11-10 22:48 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-11-10 22:48 Przemysław Wojnowski [this message]
2015-11-10 22:58 ` [PATCH] CONTRIBUTE - writing tests for understanding internals John Wiegley
2015-11-11 3:36 ` Eli Zaretskii
2015-11-11 7:45 ` Przemysław Wojnowski
2015-11-11 8:26 ` Andreas Röhler
2015-11-11 15:40 ` Eli Zaretskii
2015-11-11 15:40 ` Eli Zaretskii
2015-11-11 21:08 ` Przemysław Wojnowski
2015-11-11 21:26 ` Eli Zaretskii
2015-11-11 21:36 ` John Wiegley
2015-11-12 3:40 ` Eli Zaretskii
2015-11-11 21:48 ` Przemysław Wojnowski
2015-11-12 7:16 ` Andreas Röhler
2015-11-12 16:15 ` Eli Zaretskii
2015-11-12 20:03 ` Stephen Leake
2015-11-12 20:40 ` Andreas Röhler
2015-11-12 20:55 ` Eli Zaretskii
2015-11-12 21:42 ` Przemysław Wojnowski
2015-11-13 7:33 ` Eli Zaretskii
2015-11-13 8:03 ` Andreas Röhler
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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87twotqxme.fsf@cumego.com \
--to=esperanto@cumego.com \
--cc=emacs-devel@gnu.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 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).