Changes to support GIT.
[gpg4win.git] / doc / HACKING
1 # HACKING                                                       -*- org -*-
2 #+TITLE: Hacking notes for Gpg4win
3 #+STARTUP: showall
4
5 * No more ChangeLog files
6
7   Do not modify any of the ChangeLog files in Libassuan.  Starting on
8   March 26, 2011 we put change information only in the GIT commit log,
9   and generate a top-level ChangeLog file from logs at "make dist"
10   time.  As such, there are strict requirements on the form of the
11   commit log messages.  The old ChangeLog has been stored as
12   build-aux/git-log-footer.
13
14 * Commit log requirements
15
16   Your commit log should always start with a one-line summary, the
17   second line should be blank, and the remaining lines are usually
18   ChangeLog-style entries for all affected files.  However, it's fine
19   -- even recommended -- to write a few lines of prose describing the
20   change, when the summary and ChangeLog entries don't give enough of
21   the big picture.  Omit the leading TABs that you're used to seeing
22   in a "real" ChangeLog file, but keep the maximum line length at 72
23   or smaller, so that the generated ChangeLog lines, each with its
24   leading TAB, will not exceed 80 columns.  If you want to add text
25   which shall not be copied to the ChangeLog, separate it by a line
26   consisting of two dashes at the begin of a line.