From 10aaacbebbf180f97c66ec4418554efdea5fde95 Mon Sep 17 00:00:00 2001 From: Omar Shykhkerimov Date: Mon, 25 Apr 2016 15:58:54 +0300 Subject: [PATCH] [Murano Docs] Murano Contributor rules This commit shortly describes main rules for murano contributors. Change-Id: Idf66f4d34bf79f2dff9bad135a353f061057daaf --- .../contributor-guide/dev_guidelines.rst | 26 +++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/doc/source/draft/contributor-guide/dev_guidelines.rst b/doc/source/draft/contributor-guide/dev_guidelines.rst index 3684d896..fd9ac899 100644 --- a/doc/source/draft/contributor-guide/dev_guidelines.rst +++ b/doc/source/draft/contributor-guide/dev_guidelines.rst @@ -16,5 +16,31 @@ High-level overview of Murano components Coding guidelines ~~~~~~~~~~~~~~~~~ +There are several significant rules for the Murano developer: + +* Follow PEP8 and OpenStack style guidelines. + +* Do not import functions. Only module imports are accepted. + +* Make commits as small as possible. It speeds up review of the change. + +* Six library usage rule: use it only when really necessary (for example if + existing code will not work in python 3 at all). + +* Mark application name in the 1st line of commit message for murano-apps + repository, i.e. [Apache] or [Kubernetes]. + +* Prefer code readability over performance unless the situations when + performance penalty can be proven to be big. + +* Write Py3-compatible code. If that's impossible leave comment. + +Rules for MuranoPL coding style: + +* Use camelCase for MuranoPL functions/namespaces/variables/properties, + PascalCase for class names. + +* Consider using ``$this`` instead of ``$`` where appropriate. + Debug tips ~~~~~~~~~~