Skeleton for DRAMSys coding style guide.

coding-style.md

@@ -0,0 +1,62 @@
+
+# Coding style
+
+The DRAMSys project has long run without a coding style. As a result, there is
+a substantial amount of code which does not meet any coding style guidelines.
+
+This fact leads people to believe that the coding standards do not matter and
+are not enforced. Nevertheless, a code base as large as the DRAMSys project
+requires some uniformity of code to make it possible for developers to quickly
+understand it. So there is no longer room for strangely-formatted code.
+
+The coding style document should not be read as an absolute law which can
+never be transgressed. **If there is a good reason** to go against the style
+(a line which becomes far less readable if split to fit within the 80-column
+limit, for example), just do it.
+
+Since DRAMSys is a multi-language project, each with its own peculiarities, we
+describe the preferred coding style for them in separate.
+
+
+## DRAMSys Coding Style for C++ Code
+
++ Indentation
+
++ Breaking long lines and strings
+    
+    Coding style is all about readability and maintainability using commonly
+    available tools.
+
+    The limit on the length of lines is 80 columns and this is a strongly
+    preferred limit.
+
+    Statements longer than 80 columns will be broken into sensible chunks,
+    unless exceeding 80 columns significantly increases readability and does not
+    hide information. Descendants are always substantially shorter than the
+    parent and are placed substantially to the right. The same applies to
+    function headers with a long argument list. However, never break
+    user-visible strings such as printed messages, because that breaks the
+    ability to grep for them.
+
++ Placing Braces and Spaces
+
++ Naming
+
++ Functions
+
+
+## DRAMSys Coding Style for Python Code
+
++ We follow the PEP8 style guide.
+
++ How to use vim plugins
+
+
+## References
+
+[Linux kernel coding style](https://github.com/torvalds/linux/blob/master/Documentation/process/coding-style.rst)
+
+[C++ Core Guidelines](https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#S-cpl)
+
+[PEP 8 -- Style Guide for Python Code](https://www.python.org/dev/peps/pep-0008/)
+