|
Packit |
5e354d |
# HACKING -*- org -*-
|
|
Packit |
5e354d |
#+TITLE: Hacking notes for nPth
|
|
Packit |
5e354d |
#+STARTUP: showall
|
|
Packit |
5e354d |
|
|
Packit |
5e354d |
* No ChangeLog files
|
|
Packit |
5e354d |
|
|
Packit |
5e354d |
Do not write ChangeLog files for NPTH. We put change information
|
|
Packit |
5e354d |
only in the GIT commit log, and generate a top-level ChangeLog file
|
|
Packit |
5e354d |
from logs at "make dist" time. As such, there are strict
|
|
Packit |
5e354d |
requirements on the form of the commit log messages.
|
|
Packit |
5e354d |
|
|
Packit |
5e354d |
|
|
Packit |
5e354d |
* Commit log requirements
|
|
Packit |
5e354d |
|
|
Packit |
5e354d |
Your commit log should always start with a one-line summary, the
|
|
Packit |
5e354d |
second line should be blank, and the remaining lines are usually
|
|
Packit |
5e354d |
ChangeLog-style entries for all affected files. However, it's fine
|
|
Packit |
5e354d |
-- even recommended -- to write a few lines of prose describing the
|
|
Packit |
5e354d |
change, when the summary and ChangeLog entries don't give enough of
|
|
Packit |
5e354d |
the big picture. Omit the leading TABs that you're used to seeing
|
|
Packit |
5e354d |
in a "real" ChangeLog file, but keep the maximum line length at 72
|
|
Packit |
5e354d |
or smaller, so that the generated ChangeLog lines, each with its
|
|
Packit |
5e354d |
leading TAB, will not exceed 80 columns.
|