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: [PATCH] Adding testing information to CONTRIBUTE Date: Sun, 15 Mar 2015 10:47:00 -0700 Message-ID: NNTP-Posting-Host: plane.gmane.org X-Trace: ger.gmane.org 1426442199 3758 80.91.229.3 (15 Mar 2015 17:56:39 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sun, 15 Mar 2015 17:56:39 +0000 (UTC) Cc: stephen_leake@stephe-leake.org, emacs-devel@gnu.org To: Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sun Mar 15 18:56:24 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 1YXCly-0001Hq-OY for ged-emacs-devel@m.gmane.org; Sun, 15 Mar 2015 18:56:22 +0100 Original-Received: from localhost ([::1]:44148 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YXClx-00087P-Q6 for ged-emacs-devel@m.gmane.org; Sun, 15 Mar 2015 13:56:21 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:40935) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YXClt-0007z2-LZ for emacs-devel@gnu.org; Sun, 15 Mar 2015 13:56:18 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1YXClo-0006UJ-Ss for emacs-devel@gnu.org; Sun, 15 Mar 2015 13:56:17 -0400 Original-Received: from ec2-52-0-7-12.compute-1.amazonaws.com ([52.0.7.12]:54479 helo=samertm.com) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YXClj-0006Pw-Jn; Sun, 15 Mar 2015 13:56:07 -0400 Original-Received: from localhost (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 817CE424AA; Sun, 15 Mar 2015 17:55:41 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=samertm.com; s=mail; t=1426442141; bh=FpAITlOnnyJ6wp6f/2noz4wt5IrXpK+oczxGcwtYcIo=; h=From:Date:Subject:To:Cc:From; b=fbCRq44FjnGUEPWQbN9QiJUcUWQk60aRCzGj4gLCrybyAWRSTznh8yCCMv1v24RaU bP0K1wMx7P9zPUhTwIkyAKF9V6kiF7WBC/WBz0cTzWv6+bTIq9X1/UONVa5/tuK3VF bUxwj7MgMOLDHf1/D5HiiUQs3NVYU1pETCC859d8= 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:183883 Archived-At: 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 +" to run the tests for .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 + + * CONTRIBUTE (Test your changes.): New section. + (Document your changes.): Add doc tips. + 2015-03-02 Robert Pluim (tiny change) * configure.ac: Error out if with-file-notification=w32 is