openstack/murano
Code Issues Proposed changes
5.0.0.0b1
murano/doc/source/contributor/dev_guidelines.rst
zhurong 9cb54690e9 Adapt murano documentation for new standards 
This patch set makes the following changes:
 * using the new standards
 * Update doc/source/index.rst with new links
 * Move content of install-guide to the doc/source/install

Change-Id: Ic16671191832d949d2ea0626dcbf334ba60c56ef
2017-07-11 11:38:08 +08:00

1.1 KiB
Raw Permalink Blame History

Development guidelines

Conventions

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