Document coding principles in README

1 files changed, 21 insertions, 0 deletions

diff --git a/README b/README
index 6ddf58e..9ce5a3b 100644
--- a/README
+++ b/README
@@ -24,6 +24,27 @@ To run the test suite:
 You MUST successfully run the test suite before submitting patches.
 
 
+Coding principles
+-----------------
+
+The code of `distix` is meant to obey all of the below:
+
+* Code is clean and easy to understand.
+* Code is maintainable, easy to modify, and easy to debug.
+* There is no unnecessary code.
+* Code is correct.
+* All of the code is fully tested by unit tests, unless excplitly
+  makred outside of test coverage; all exceptions are justified in
+  code with a comment.
+* All non-interactive user and program interfaces are tested by
+  integration tests implemented with yarn. Testing of interactive user
+  interaces may rely on manual testing.
+
+Any failures to meet all of the above should be treated as bugs.
+
+Code should be developed using test driven development.
+
+
 Legalese
 --------