[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

[newdak/master] Added a few hints so we keep consistency (hopefully) Signed-off-by: Joerg Jaspert <joerg@debian.org>



---
 CodingStyle.txt |   29 +++++++++++++++++++++++++++++
 1 files changed, 29 insertions(+), 0 deletions(-)
 create mode 100644 CodingStyle.txt

diff --git a/CodingStyle.txt b/CodingStyle.txt
new file mode 100644
index 0000000..4678275
--- /dev/null
+++ b/CodingStyle.txt
@@ -0,0 +1,29 @@
+Some small guidelines
+---------------------
+
+Code related:
+
+- Use readable and self-speaking variable names.
+
+- Its 4 spaces per indentation. No tab.
+
+- Describe *every* function you write using a docstring. No matter how small.
+
+- Also describe every file.
+
+- Don't forget the Copyright/License header in a file. We expect GPLv2 :)
+
+- Don't write long functions. If it goes above a sane limit (like 50
+  lines) - split it up.
+
+- Look at / read http://www.python.org/dev/peps/pep-0008/
+
+
+VCS related:
+
+- History rewriting is considered bad.
+
+- Always have a "Signed-off-by" line in your commit.
+
+- If you merge from others (fine), please use mergeoptions = --no-ff --no-commit
+  We want to see who actually merged the code.
-- 
1.5.6.3


Reply to: