Implement git magic to create beta version numbers.
[npth.git] / HACKING
1 # HACKING                                                       -*- org -*-
2 #+TITLE: Hacking notes for NPTH
3 #+STARTUP: showall
4
5 * No ChangeLog files
6
7   Do not write ChangeLog files for NPTH.  We put change information
8   only in the GIT commit log, and generate a top-level ChangeLog file
9   from logs at "make dist" time.  As such, there are strict
10   requirements on the form of the commit log messages.
11
12
13 * Commit log requirements
14
15   Your commit log should always start with a one-line summary, the
16   second line should be blank, and the remaining lines are usually
17   ChangeLog-style entries for all affected files.  However, it's fine
18   -- even recommended -- to write a few lines of prose describing the
19   change, when the summary and ChangeLog entries don't give enough of
20   the big picture.  Omit the leading TABs that you're used to seeing
21   in a "real" ChangeLog file, but keep the maximum line length at 72
22   or smaller, so that the generated ChangeLog lines, each with its
23   leading TAB, will not exceed 80 columns.