procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Documentation and testing tips for CONTRIBUTE

Browse source 
CONTRIBUTE (Test your changes.): New section.
 (Document your changes.): Add doc tips.
This commit is contained in:
Samer Masterson 2015-03-21 12:09:30 +02:00 • committed by Eli Zaretskii
parent fa734d07ab
commit 70565a2176
2 changed files with 25 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
CONTRIBUTE
View file

@ -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
<filename>" to run the tests for <filename>.el(c). See
"test/automated/Makefile" for more information.
** Understanding Emacs Internals.
The best way to understand Emacs Internals is to read the code,

5
ChangeLog
View file

@ -1,3 +1,8 @@
2015-03-21 Samer Masterson <samer@samertm.com>
* CONTRIBUTE (Test your changes.): New section.
(Document your changes.): Add doc tips.
2015-03-19 Paul Eggert <eggert@cs.ucla.edu>
Better port of pthread usage to FreeBSD