diff options
| author | Samer Masterson | 2015-03-21 12:09:30 +0200 |
|---|---|---|
| committer | Eli Zaretskii | 2015-03-21 12:09:30 +0200 |
| commit | 70565a21765ea5f9b163e1a0ef1331df03c7fc67 (patch) | |
| tree | 19ce3343f012bbc159341926ca96a85152fbdfa4 | |
| parent | fa734d07ab9dd00ad29d68668ed25247c9000aef (diff) | |
| download | emacs-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-- | CONTRIBUTE | 20 | ||||
| -rw-r--r-- | ChangeLog | 5 |
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 | |||
| 187 | that *all* the necessary documentation updates have been made, mark | 187 | that *all* the necessary documentation updates have been made, mark |
| 188 | the entry with "+++". Otherwise do not mark it. | 188 | the entry with "+++". Otherwise do not mark it. |
| 189 | 189 | ||
| 190 | Please see (info "(elisp)Documentation Tips") or | ||
| 191 | https://www.gnu.org/software/emacs/manual/html_node/elisp/Documentation-Tips.html | ||
| 192 | for more specific tips on Emacs's doc style. Use `checkdoc' to check | ||
| 193 | for documentation errors before submitting a patch. | ||
| 194 | |||
| 195 | ** Test your changes. | ||
| 196 | |||
| 197 | Please test your changes before committing them or sending them to the | ||
| 198 | list. | ||
| 199 | |||
| 200 | Emacs uses ERT, Emacs Lisp Regression Testing, for testing. See (info | ||
| 201 | "(ert)") or https://www.gnu.org/software/emacs/manual/html_node/ert/ | ||
| 202 | for more information on writing and running tests. | ||
| 203 | |||
| 204 | To run tests on the entire Emacs tree, run "make check" from the | ||
| 205 | top-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 | ||
| 192 | The best way to understand Emacs Internals is to read the code, | 212 | The best way to understand Emacs Internals is to read the code, |
| @@ -1,3 +1,8 @@ | |||
| 1 | 2015-03-21 Samer Masterson <samer@samertm.com> | ||
| 2 | |||
| 3 | * CONTRIBUTE (Test your changes.): New section. | ||
| 4 | (Document your changes.): Add doc tips. | ||
| 5 | |||
| 1 | 2015-03-19 Paul Eggert <eggert@cs.ucla.edu> | 6 | 2015-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 |