From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: =?utf-8?Q?Przemys=C5=82aw_Wojnowski?= Newsgroups: gmane.emacs.devel Subject: [PATCH] CONTRIBUTE - writing tests for understanding internals Date: Tue, 10 Nov 2015 23:48:41 +0100 Message-ID: <87twotqxme.fsf@cumego.com> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Trace: ger.gmane.org 1447195770 12183 80.91.229.3 (10 Nov 2015 22:49:30 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Tue, 10 Nov 2015 22:49:30 +0000 (UTC) To: Emacs Developers Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Tue Nov 10 23:49:22 2015 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1ZwHid-0007NB-C5 for ged-emacs-devel@m.gmane.org; Tue, 10 Nov 2015 23:48:51 +0100 Original-Received: from localhost ([::1]:35956 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZwHic-0001XD-Td for ged-emacs-devel@m.gmane.org; Tue, 10 Nov 2015 17:48:50 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:37209) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZwHiZ-0001Wu-CZ for emacs-devel@gnu.org; Tue, 10 Nov 2015 17:48:48 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ZwHiW-0002X7-24 for emacs-devel@gnu.org; Tue, 10 Nov 2015 17:48:47 -0500 Original-Received: from smtp23.iq.pl ([86.111.242.228]:41788) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZwHiV-0002WL-Nv for emacs-devel@gnu.org; Tue, 10 Nov 2015 17:48:43 -0500 Original-Received: (qmail 7412 invoked from network); 10 Nov 2015 22:48:42 -0000 Original-Received: from unknown (HELO namek.cumego.com) (esperanto@cumego.com@[159.205.193.173]) (envelope-sender ) by smtp22.iq.pl with AES128-GCM-SHA256 encrypted SMTP for ; 10 Nov 2015 22:48:42 -0000 User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.0.50 (gnu/linux) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 86.111.242.228 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:193987 Archived-At: --=-=-= Content-Type: text/plain 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. :-) --=-=-= Content-Type: text/x-diff Content-Disposition: inline; filename=0001-CONTRIBUTE-Add-testing-to-understanding-Emacs-Intern.patch Content-Description: writing tests to understand internals >From 6d59909ba6166b0d19a2d690caec52387280e2e7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Przemys=C5=82aw=20Wojnowski?= 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 --=-=-=--