CONTRIBUTE 17.1 KB
Newer Older
1
* How developers contribute to GNU Emacs
Juri Linkov's avatar
Juri Linkov committed
2

3
Here is how software developers can contribute to Emacs.  (Non-developers: see
4
https://www.gnu.org/software/emacs/manual/html_node/emacs/Contributing.html
5
or run the shell command 'info "(emacs)Contributing"'.)
Juri Linkov's avatar
Juri Linkov committed
6

7
** The Emacs repository
Juri Linkov's avatar
Juri Linkov committed
8

9 10
Emacs development uses Git on Savannah for its main repository.
Briefly, the following shell commands build and run Emacs from scratch:
Juri Linkov's avatar
Juri Linkov committed
11

12 13 14 15 16
	git config --global user.name 'Your Name'
	git config --global user.email 'your.name@example.com'
	git config --global transfer.fsckObjects true
	git clone git://git.sv.gnu.org/emacs.git
	cd emacs
Paul Eggert's avatar
Paul Eggert committed
17
	./autogen.sh
18 19 20
	./configure
	make
	src/emacs
Juri Linkov's avatar
Juri Linkov committed
21

22 23 24 25
For more details, see
http://www.emacswiki.org/emacs/GitQuickStartForEmacsDevs and
http://www.emacswiki.org/emacs/GitForEmacsDevs or see the file
admin/notes/git-workflow.
Juri Linkov's avatar
Juri Linkov committed
26

27
** Getting involved with development
Juri Linkov's avatar
Juri Linkov committed
28

29
Discussion about Emacs development takes place on emacs-devel@gnu.org.
30 31 32 33 34
You can subscribe to the emacs-devel@gnu.org mailing list.
If you want to get only the important mails (for things like
feature freezes), choose to receive only the 'emacs-announce' topic
(although so far this feature has not been well or consistently used).
See https://lists.gnu.org/mailman/listinfo/emacs-devel for mailing list
35 36 37 38
instructions and archives.  You can develop and commit changes in your
own copy of the repository, and discuss proposed changes on the
mailing list.  Frequent contributors to Emacs can request write access
there.
Juri Linkov's avatar
Juri Linkov committed
39

40 41
Bug reports and fixes, feature requests and patches/implementations
should be sent to bug-gnu-emacs@gnu.org, the bug/feature list.  This
42
is coupled to the https://debbugs.gnu.org tracker.  It is best to use
43 44 45
the command 'M-x report-emacs-bug RET' to report issues to the tracker
(described below).  Be prepared to receive comments and requests for
changes in your patches, following your submission.
Juri Linkov's avatar
Juri Linkov committed
46

47
The Savannah info page https://savannah.gnu.org/mail/?group=emacs
48 49 50 51 52 53 54 55 56 57 58
describes how to subscribe to the mailing lists, or see the list
archives.

To email a patch you can use a shell command like 'git format-patch -1'
to create a file, and then attach the file to your email.  This nicely
packages the patch's commit message and changes.  To send just one
such patch without additional remarks, you can use a command like
'git send-email --to=bug-gnu-emacs@gnu.org 0001-DESCRIPTION.patch'.

** Issue tracker (a.k.a. "bug tracker")

59
The Emacs issue tracker at https://debbugs.gnu.org lets you view bug
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
reports and search the database for bugs matching several criteria.
Messages posted to the bug-gnu-emacs@gnu.org mailing list, mentioned
above, are recorded by the tracker with the corresponding bugs/issues.

GNU ELPA has a 'debbugs' package that allows accessing the tracker
database from Emacs.

Bugs needs regular attention.  A large backlog of bugs is
disheartening to the developers, and a culture of ignoring bugs is
harmful to users, who expect software that works.  Bugs have to be
regularly looked at and acted upon.  Not all bugs are critical, but at
the least, each bug needs to be regularly re-reviewed to make sure it
is still reproducible.

The process of going through old or new bugs and acting on them is
called bug triage.  This process is described in the file
admin/notes/bug-triage.

** Documenting your changes

Any change that matters to end-users should have an entry in etc/NEWS.
81 82 83
Try to start each NEWS entry with a sentence that summarizes the entry
and takes just one line -- this will allow to read NEWS in Outline
mode after hiding the body of each entry.
84 85 86

Doc-strings should be updated together with the code.

87 88 89 90
New defcustom's should always have a ':version' tag stating the first
Emacs version in which they will appear.  Likewise with defcustom's
whose value is changed -- update their ':version' tag.

91 92
Think about whether your change requires updating the manuals.  If you
know it does not, mark the NEWS entry with "---".  If you know
93 94 95
that *all* the necessary documentation updates have been made as part
of your changes or those by others, mark the entry with "+++".
Otherwise do not mark it.
96 97 98 99

If your change requires updating the manuals to document new
functions/commands/variables/faces, then use the proper Texinfo
command to index them; for instance, use @vindex for variables and
Eli Zaretskii's avatar
Eli Zaretskii committed
100
@findex for functions/commands.  For the full list of predefined indices, see
101
https://www.gnu.org/software/texinfo/manual/texinfo/html_node/Predefined-Indices.html
102 103
or run the shell command 'info "(texinfo)Predefined Indices"'.

104 105 106 107
We prefer American English both in doc strings and in the manuals.
That includes both spelling (e.g., "behavior", not "behaviour") and
the convention of leaving 2 spaces between sentences.

108
For more specific tips on Emacs's doc style, see
109
https://www.gnu.org/software/emacs/manual/html_node/elisp/Documentation-Tips.html
110 111 112 113 114 115 116 117 118 119
Use 'checkdoc' to check for documentation errors before submitting a patch.

** Testing your changes

Please test your changes before committing them or sending them to the
list.  If possible, add a new test along with any bug fix or new
functionality you commit (of course, some changes cannot be easily
tested).

Emacs uses ERT, Emacs Lisp Regression Testing, for testing.  See
120
https://www.gnu.org/software/emacs/manual/html_node/ert/
121
or run 'info "(ert)"' for more information on writing and running
122 123 124 125 126 127 128 129 130
tests.

If your test lasts longer than some few seconds, mark it in its
'ert-deftest' definition with ":tags '(:expensive-test)".

To run tests on the entire Emacs tree, run "make check" from the
top-level directory.  Most tests are in the directory "test/".  From
the "test/" directory, run "make <filename>" to run the tests for
<filename>.el(c).  See "test/README" for more information.
Juri Linkov's avatar
Juri Linkov committed
131

132
** Commit messages
133

134 135 136
Ordinarily, a change you commit should contain a log entry in its
commit message and should not touch the repository's ChangeLog files.
Here is an example commit message (indented):
137 138 139 140

	Deactivate shifted region

	Do not silently extend a region that is not highlighted;
141
	this can happen after a shift (Bug#19003).
142 143 144 145 146
	* doc/emacs/mark.texi (Shift Selection): Document the change.
	* lisp/window.el (handle-select-window):
	* src/frame.c (Fhandle_switch_frame, Fselected_frame):
	Deactivate the mark.

147 148 149
Occasionally, commit messages are collected and prepended to a
ChangeLog file, where they can be corrected.  It saves time to get
them right the first time, so here are guidelines for formatting them:
150

Eli Zaretskii's avatar
Eli Zaretskii committed
151 152
- Start with a single unindented summary line explaining the change;
  do not end this line with a period.  If that line starts with a
153
  semicolon and a space "; ", the commit message will be ignored when
Eli Zaretskii's avatar
Eli Zaretskii committed
154 155 156 157 158
  generating the ChangeLog file.  Use this for minor commits that do
  not need separate ChangeLog entries, such as changes in etc/NEWS.

- After the summary line, there should be an empty line, then
  unindented ChangeLog entries.
159

160
- Limit lines in commit messages to 78 characters, unless they consist
161 162 163 164 165
  of a single word of at most 140 characters; this is enforced by a
  commit hook.  It's nicer to limit the summary line to 50 characters;
  this isn't enforced.  If the change can't be summarized so briefly,
  add a paragraph after the empty line and before the individual file
  descriptions.
166 167 168 169 170

- If only a single file is changed, the summary line can be the normal
  file first line (starting with the asterisk).  Then there is no
  individual files section.

171
- If the commit has more than one author, the commit message should
172
  contain separate lines to mention the other authors, like the
173
  following:
Eli Zaretskii's avatar
Eli Zaretskii committed
174 175 176 177 178 179 180 181 182 183 184

	Co-authored-by: Joe Schmoe <j.schmoe@example.org>

- If the commit is a tiny change that is exempt from copyright paperwork,
  the commit message should contain a separate line like the following:

	Copyright-paperwork-exempt: yes

- The commit message should contain "Bug#NNNNN" if it is related to
  bug number NNNNN in the debbugs database.  This string is often
  parenthesized, as in "(Bug#19003)".
185

186 187 188
- When citing URLs, prefer https: to http: when either will do.  In
  particular, gnu.org and fsf.org URLs should start with "https:".

189 190
- Commit messages should contain only printable UTF-8 characters.

Paul Eggert's avatar
Paul Eggert committed
191
- Commit messages should not contain the "Signed-off-by:" lines that
192 193
  are used in some other projects.

194
- Any lines of the commit message that start with "; " are omitted
195 196
  from the generated ChangeLog.

Eli Zaretskii's avatar
Eli Zaretskii committed
197 198 199 200 201
- Explaining the rationale for a design choice is best done in comments
  in the source code.  However, sometimes it is useful to describe just
  the rationale for a change; that can be done in the commit message
  between the summary line and the file entries.

202
- Emacs generally follows the GNU coding standards for ChangeLogs: see
203
  https://www.gnu.org/prep/standards/html_node/Change-Logs.html
204 205 206 207
  or run 'info "(standards)Change Logs"'.  One exception is that
  commits still sometimes quote `like-this' (as the standards used to
  recommend) rather than 'like-this' or ‘like this’ (as they do now),
  as `...' is so widely used elsewhere in Emacs.
208

209 210 211 212
- Some commenting rules in the GNU coding standards also apply
  to ChangeLog entries: they must be in English, and be complete
  sentences starting with a capital and ending with a period (except
  the summary line should not end in a period).  See
213
  https://www.gnu.org/prep/standards/html_node/Comments.html
214
  or run 'info "(standards)Comments"'.  American English is preferred
215 216
  in Emacs; that includes spelling and leaving 2 blanks between
  sentences.
217

218 219 220
  They are preserved indefinitely, and have a reasonable chance of
  being read in the future, so it's better that they have good
  presentation.
221 222 223 224

- Use the present tense; describe "what the change does", not "what
  the change did".

225 226
- Preferred form for several entries with the same content:

227 228 229 230 231 232
	* lisp/menu-bar.el (clipboard-yank, clipboard-kill-ring-save)
	(clipboard-kill-region):
	* lisp/eshell/esh-io.el (eshell-virtual-targets)
	(eshell-clipboard-append):
	Replace option gui-select-enable-clipboard with
	select-enable-clipboard; renamed October 2014.  (Bug#25145)
233 234 235

  (Rather than anything involving "ditto" and suchlike.)

Eli Zaretskii's avatar
Eli Zaretskii committed
236 237 238 239
- There is no standard or recommended way to identify revisions in
  ChangeLog entries.  Using Git SHA1 values limits the usability of
  the references to Git, and will become much less useful if Emacs
  switches to a different VCS.  So we recommend against that.
240 241 242 243

  One way to identify revisions is by quoting their summary line.
  Another is with an action stamp - an RFC3339 date followed by !
  followed by the committer's email - for example,
Eli Zaretskii's avatar
Eli Zaretskii committed
244
  "2014-01-16T05:43:35Z!esr@thyrsus.com".  Often, "my previous commit"
245 246
  will suffice.

Xue Fuqiao's avatar
Xue Fuqiao committed
247
- There is no need to mention files such as NEWS and MAINTAINERS, or
248
  to indicate regeneration of files such as 'lib/gnulib.mk', in the
Xue Fuqiao's avatar
Xue Fuqiao committed
249 250
  ChangeLog entry.  "There is no need" means you don't have to, but
  you can if you want to.
251

252 253
** Generating ChangeLog entries

254
- You can use Emacs functions to write ChangeLog entries; see
255
  https://www.gnu.org/software/emacs/manual/html_node/emacs/Change-Log-Commands.html
256
  or run 'info "(emacs)Change Log Commands"'.
257 258

- If you use Emacs VC, one way to format ChangeLog entries is to create
259
  a top-level ChangeLog file manually, and update it with 'C-x 4 a' as
260
  usual.  Do not register the ChangeLog file under git; instead, use
261
  'C-c C-a' to insert its contents into your *vc-log* buffer.
262
  Or if 'log-edit-hook' includes 'log-edit-insert-changelog' (which it
263
  does by default), they will be filled in for you automatically.
264 265 266 267 268 269 270 271

- Alternatively, you can use the vc-dwim command to maintain commit
  messages.  When you create a source directory, run the shell command
  'git-changelog-symlink-init' to create a symbolic link from
  ChangeLog to .git/c/ChangeLog.  Edit this ChangeLog via its symlink
  with Emacs commands like 'C-x 4 a', and commit the change using the
  shell command 'vc-dwim --commit'.  Type 'vc-dwim --help' for more.

272 273 274 275 276 277
** Committing changes by others

If committing changes written by someone else, commit in their name,
not yours.  You can use 'git commit --author="AUTHOR"' to specify a
change's author.

Eli Zaretskii's avatar
Eli Zaretskii committed
278
** Branches
279

280 281 282 283 284 285 286 287
Future development normally takes place on the master branch.
Sometimes specialized features are developed on other branches before
possibly being merged to the master.  Release branches are named
"emacs-NN" where NN is the major version number, and are mainly
intended for more-conservative changes such as bug fixes.  Typically,
collective development is active on the master branch and possibly on
the current release branch.  Periodically, the current release branch
is merged into the master, using the gitmerge function described in
Eli Zaretskii's avatar
Eli Zaretskii committed
288
admin/notes/git-workflow.
289

290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
If you are fixing a bug that exists in the current release, you should
generally commit it to the release branch; it will be merged to the
master branch later by the gitmerge function.  However, when the
release branch is for Emacs version NN.2 and later, or when it is for
Emacs version NN.1 that is in the very last stages of its pretest,
that branch is considered to be in a feature freeze: only bug fixes
that are "safe" or are fixing major problems should go to the release
branch, the rest should be committed to the master branch.  This is so
to avoid destabilizing the next Emacs release.  If you are unsure
whether your bug fix is "safe" enough for the release branch, ask on
the emacs-devel mailing list.

Documentation fixes (in doc strings, in manuals, in NEWS, and in
comments) should always go to the release branch, if the documentation
to be fixed exists and is relevant to the release-branch codebase.
Doc fixes are always considered "safe" -- even when a release branch
is in feature freeze, it can still receive doc fixes.
307

308
When you know that the change will be difficult to merge to the
309
master (e.g., because the code on master has changed a lot), you can
310 311 312
apply the change to both master and branch yourself.  It could also
happen that a change is cherry-picked from master to the release
branch, and so doesn't need to be merged back.  In these cases,
313 314 315
say in the release branch commit message that there is no need to merge
the commit to master, by starting the commit message with "Backport:".
The gitmerge function excludes these commits from the merge to the master.
316 317 318 319

Some changes should not be merged to master at all, for whatever
reasons.  These should be marked by including something like "Do not
merge to master" or anything that matches gitmerge-skip-regexp (see
320
admin/gitmerge.el) in the commit message.
321

322 323 324 325 326
** GNU ELPA

This repository does not contain the Emacs Lisp package archive
(elpa.gnu.org).  See admin/notes/elpa for how to access the GNU ELPA
repository.
Juri Linkov's avatar
Juri Linkov committed
327

328 329 330 331 332 333
** Understanding Emacs internals

The best way to understand Emacs internals is to read the code.  Some
source files, such as xdisp.c, have extensive comments describing the
design and implementation.  The following resources may also help:

334 335
https://www.gnu.org/software/emacs/manual/html_node/elisp/Tips.html
https://www.gnu.org/software/emacs/manual/html_node/elisp/GNU-Emacs-Internals.html
Juri Linkov's avatar
Juri Linkov committed
336

337
or run 'info "(elisp)Tips"' or 'info "(elisp)GNU Emacs Internals"'.
Juri Linkov's avatar
Juri Linkov committed
338 339 340

The file etc/DEBUG describes how to debug Emacs bugs.

341 342
*** Non-ASCII characters in Emacs files

343 344 345 346 347
If you introduce non-ASCII characters into Emacs source files, use the
UTF-8 encoding unless it cannot do the job for some good reason.
Although it is generally a good idea to add 'coding:' cookies to
non-ASCII source files, cookies are not needed in UTF-8-encoded *.el
files intended for use only with Emacs version 24.5 and later.
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368

*** Useful files in the admin/ directory

See all the files in admin/notes/* .  In particular, see
admin/notes/newfile, see admin/notes/repo.

The file admin/MAINTAINERS records the areas of interest of frequent
Emacs contributors.  If you are making changes in one of the files
mentioned there, it is a good idea to consult the person who expressed
an interest in that file, and/or get his/her feedback for the changes.
If you are a frequent contributor and have interest in maintaining
specific files, please record those interests in that file, so that
others could be aware of that.

*** git vs rename

Git does not explicitly represent a file renaming; it uses a percent
changed heuristic to deduce that a file was renamed.  So if you are
planning to make extensive changes to a file after renaming it (or
moving it to another directory), you should:

369
- Create a feature branch.
370

371
- Commit the rename without any changes.
372

373
- Make other changes.
374

375 376 377
- Merge the feature branch to the master branch, instead of squashing
  the commits into one.  The commit message on this merge should
  summarize the renames and all the changes.
378

Juri Linkov's avatar
Juri Linkov committed
379 380 381 382


This file is part of GNU Emacs.

383
GNU Emacs is free software: you can redistribute it and/or modify
Juri Linkov's avatar
Juri Linkov committed
384
it under the terms of the GNU General Public License as published by
385 386
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Juri Linkov's avatar
Juri Linkov committed
387 388 389 390 391 392 393

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
394
along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
Juri Linkov's avatar
Juri Linkov committed
395 396 397 398

Local variables:
mode: outline
paragraph-separate: "[ 	]*$"
399
coding: utf-8
Juri Linkov's avatar
Juri Linkov committed
400
end: