summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorhut <hut@lepus.uberspace.de>2016-01-24 23:37:35 +0100
committerhut <hut@lepus.uberspace.de>2016-01-24 23:37:35 +0100
commit336cd083bad11e40c5333972001cf20df78497f7 (patch)
tree22bb9a843037eb612ad429c2d7551c213cde83b1
parent2f04fb98ddac7bc558666d5817750af3a25a7bf5 (diff)
downloadranger-336cd083bad11e40c5333972001cf20df78497f7.tar.gz
HACKING: document the COMPAT convention
-rw-r--r--HACKING.md4
1 files changed, 4 insertions, 0 deletions
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