path: root/doc/HACKING
diff options
Diffstat (limited to 'doc/HACKING')
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/HACKING b/doc/HACKING
new file mode 100644
index 0000000..6149d25
--- /dev/null
+++ b/doc/HACKING
@@ -0,0 +1,28 @@
+# HACKING -*- org -*-
+#+TITLE: Hacking notes for GPGME
+#+STARTUP: showall
+* No more ChangeLog files
+ Do not modify any of the ChangeLog files in GPGME. Starting
+ on December 1st, 2011 we put change information only in the GIT
+ commit log, and generate a top-level ChangeLog file from logs at
+ "make dist" time. As such, there are strict requirements on the
+ form of the commit log messages. The old ChangeLog files have all
+ be renamed to ChangeLog-2011
+* Commit log requirements
+ Your commit log should always start with a one-line summary, the
+ second line should be blank, and the remaining lines are usually
+ ChangeLog-style entries for all affected files. However, it's fine
+ -- even recommended -- to write a few lines of prose describing the
+ change, when the summary and ChangeLog entries don't give enough of
+ the big picture. Omit the leading TABs that you're used to seeing
+ in a "real" ChangeLog file, but keep the maximum line length at 72
+ or smaller, so that the generated ChangeLog lines, each with its
+ leading TAB, will not exceed 80 columns.
+ Note that ./ installs a git hook to do some basic syntax
+ checking on the commit log message.