file first line (starting with the asterisk). Then there is no
individual files section.
-- If the commit has authors other than yourself, the commit message
- should contain a separate line like the following:
+- If the commit has more than one author, the commit message should
+ contain separate lines to mention the other authors, like the
+ following:
Co-authored-by: Joe Schmoe <j.schmoe@example.org>
- Commit messages should not contain the "Signed-off-by:" lines that
are used in some other projects.
+- Any lines of the commit message that start with "; " are omitted
+ from the generated ChangeLog.
+
- 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
** Other process information
+*** Non-ASCII characters in Emacs files
+
+If you introduce non-ASCII characters into Emacs source files, it is a
+good idea to add a 'coding' cookie to the file to state its encoding.
+Please use the UTF-8 encoding unless it cannot do the job for some
+good reason. As of Emacs 24.4, it is no longer necessary to have
+explicit 'coding' cookies in *.el files if they are encoded in UTF-8,
+but other files need them even if encoded in UTF-8. However, if
+an *.el file is intended for use with older Emacs versions (e.g. if
+it's also distributed via ELPA), having an explicit encoding
+specification is still a good idea.
+
+*** 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
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.
+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'.
** Document your changes.