From 336cd083bad11e40c5333972001cf20df78497f7 Mon Sep 17 00:00:00 2001
From: hut <hut@lepus.uberspace.de>
Date: Sun, 24 Jan 2016 23:37:35 +0100
Subject: HACKING: document the COMPAT convention

---
 HACKING.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/HACKING.md b/HACKING.md
index 3ac46cad..a961e2e4 100644
--- a/HACKING.md
+++ b/HACKING.md
@@ -9,6 +9,10 @@ Coding Style
 * Follow the style guide for python code:
     http://www.python.org/dev/peps/pep-0008/
 * Test the code with "doctest" where it makes sense
+* when breaking backward compatibility with old configuration files or plugins,
+  please include a temporary workaround code that provides a compatibility
+  layer and mark it with a comment that includes the word "COMPAT".  For
+  examples, grep the code for the word "COMPAT". :)
 
 
 Patches
-- 
cgit 1.4.1-2-gfad0