aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSamer Masterson2015-03-21 12:09:30 +0200
committerEli Zaretskii2015-03-21 12:09:30 +0200
commit70565a21765ea5f9b163e1a0ef1331df03c7fc67 (patch)
tree19ce3343f012bbc159341926ca96a85152fbdfa4
parentfa734d07ab9dd00ad29d68668ed25247c9000aef (diff)
downloademacs-70565a21765ea5f9b163e1a0ef1331df03c7fc67.tar.gz
emacs-70565a21765ea5f9b163e1a0ef1331df03c7fc67.zip
Documentation and testing tips for CONTRIBUTE
CONTRIBUTE (Test your changes.): New section. (Document your changes.): Add doc tips.
-rw-r--r--CONTRIBUTE20
-rw-r--r--ChangeLog5
2 files changed, 25 insertions, 0 deletions
diff --git a/CONTRIBUTE b/CONTRIBUTE
index 5cf015fe11a..7c40227b6d9 100644
--- a/CONTRIBUTE
+++ b/CONTRIBUTE
@@ -187,6 +187,26 @@ know it does not, mark the NEWS entry with "---". If you know
187that *all* the necessary documentation updates have been made, mark 187that *all* the necessary documentation updates have been made, mark
188the entry with "+++". Otherwise do not mark it. 188the entry with "+++". Otherwise do not mark it.
189 189
190Please see (info "(elisp)Documentation Tips") or
191https://www.gnu.org/software/emacs/manual/html_node/elisp/Documentation-Tips.html
192for more specific tips on Emacs's doc style. Use `checkdoc' to check
193for documentation errors before submitting a patch.
194
195** Test your changes.
196
197Please test your changes before committing them or sending them to the
198list.
199
200Emacs uses ERT, Emacs Lisp Regression Testing, for testing. See (info
201"(ert)") or https://www.gnu.org/software/emacs/manual/html_node/ert/
202for more information on writing and running tests.
203
204To run tests on the entire Emacs tree, run "make check" from the
205top-level directory. Most tests are in the directory
206"test/automated". From the "test/automated" directory, run "make
207<filename>" to run the tests for <filename>.el(c). See
208"test/automated/Makefile" for more information.
209
190** Understanding Emacs Internals. 210** Understanding Emacs Internals.
191 211
192The best way to understand Emacs Internals is to read the code, 212The best way to understand Emacs Internals is to read the code,
diff --git a/ChangeLog b/ChangeLog
index a79863a839e..c155708f1f4 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
12015-03-21 Samer Masterson <samer@samertm.com>
2
3 * CONTRIBUTE (Test your changes.): New section.
4 (Document your changes.): Add doc tips.
5
12015-03-19 Paul Eggert <eggert@cs.ucla.edu> 62015-03-19 Paul Eggert <eggert@cs.ucla.edu>
2 7
3 Better port of pthread usage to FreeBSD 8 Better port of pthread usage to FreeBSD