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