From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Samer Masterson Newsgroups: gmane.emacs.devel Subject: Re: Adding testing information to CONTRIBUTE Date: Thu, 05 Mar 2015 06:14:20 -0800 Message-ID: <1425564860.10893.0@mail.samertm.com> References: <1425553346.2108.2@mail.samertm.com> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: multipart/alternative; boundary="=-GjSMvnn3BW3FOOjdvssN" X-Trace: ger.gmane.org 1425564895 16897 80.91.229.3 (5 Mar 2015 14:14:55 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Thu, 5 Mar 2015 14:14:55 +0000 (UTC) Cc: stephen_leake@stephe-leake.org To: Emacs developers Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Thu Mar 05 15:14:48 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 1YTWY4-0000k2-7l for ged-emacs-devel@m.gmane.org; Thu, 05 Mar 2015 15:14:48 +0100 Original-Received: from localhost ([::1]:52029 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YTWY3-0005be-Dj for ged-emacs-devel@m.gmane.org; Thu, 05 Mar 2015 09:14:47 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:52234) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YTWXw-0005VY-5f for emacs-devel@gnu.org; Thu, 05 Mar 2015 09:14:44 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1YTWXr-00089p-Oa for emacs-devel@gnu.org; Thu, 05 Mar 2015 09:14:40 -0500 Original-Received: from ec2-52-0-7-12.compute-1.amazonaws.com ([52.0.7.12]:50462 helo=samertm.com) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YTWXr-00089b-HS for emacs-devel@gnu.org; Thu, 05 Mar 2015 09:14:35 -0500 Original-Received: from [10.1.10.16] (c-98-210-154-226.hsd1.ca.comcast.net [98.210.154.226]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by samertm.com (Postfix) with ESMTPSA id 6E44342D22; Thu, 5 Mar 2015 14:14:18 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=samertm.com; s=mail; t=1425564859; bh=W1kcS/zLdoqP9+dvLC2PIm54RkZaHDxX4Ri1qDzdUG4=; h=Date:From:Subject:To:Cc:In-Reply-To:References:From; b=qo4msXrWEiw2HKaZtahA29tXAebgcxv92DvyUIa1SkQmPEQt4TQSwKF8JsZlf2/JS NXVXEgc+Mejvdfn2NeuWjkk/QenhFEDHQRI7U7DvCfQ8lPSZzk4StIrPXv/bVhCoBS +xtTSCD8jPsq4QzACyuoNAX14LRZlIo1HsURoz7w= In-Reply-To: <1425553346.2108.2@mail.samertm.com> X-Mailer: geary/0.9.1 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 52.0.7.12 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:183669 Archived-At: --=-GjSMvnn3BW3FOOjdvssN Content-Type: text/plain; charset=utf-8; format=flowed I just learned about checkdoc, and it should probably be mentioned too. On Thu, Mar 5, 2015 at 3:02 AM, Samer Masterson 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 --=-GjSMvnn3BW3FOOjdvssN Content-Type: text/html; charset=utf-8 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 Step hen Leake because he lead the most recent major changes to CONTRIBUTE.

-samer
--=-GjSMvnn3BW3FOOjdvssN--