summaryrefslogtreecommitdiff
path: root/doc/reference/guidelines.rst
diff options
context:
space:
mode:
authorThibault Delavallée <tde@odoo.com>2018-03-06 15:15:57 +0100
committerThibault Delavallée <tde@odoo.com>2018-03-13 17:26:29 +0100
commitdab7368c43f3720a9e9f22c31f5c656b14c9f920 (patch)
tree67db8f06ce8b0ee8b3dc42c5734a5f2de58793bf /doc/reference/guidelines.rst
parent820926f5ba9383b05334fbe5914006d629bbb3dd (diff)
[IMP] doc: improve wording of guidelines introduction
Purpose of this commit is to clean a bit the wording and to clarify how to handle guidelines between stable and development versions.
Diffstat (limited to 'doc/reference/guidelines.rst')
-rw-r--r--doc/reference/guidelines.rst23
1 files changed, 16 insertions, 7 deletions
diff --git a/doc/reference/guidelines.rst b/doc/reference/guidelines.rst
index 3aa2a346cb5..041ff8bf619 100644
--- a/doc/reference/guidelines.rst
+++ b/doc/reference/guidelines.rst
@@ -6,17 +6,26 @@
Odoo Guidelines
===============
-This page introduces the new Odoo Coding Guidelines. Those aim to improve the quality of the code (e.g. better readability of source) and Odoo Apps. Indeed, proper code eases maintenance, aids debugging, lowers complexity and promotes reliability.
+This page introduces the Odoo Coding Guidelines. Those aim to improve the
+quality of Odoo Apps code. Indeed proper code improves readability, eases
+maintenance, helps debugging, lowers complexity and promotes reliability.
+These guidelines should be applied to every new module and to all new development.
-These guidelines should be applied to every new module, and new development.
+.. warning::
+
+ When modifying existing files in **stable version** the original file style
+ strictly supersedes any other style guidelines. In other words please never
+ modify existing files in order to apply these guidelines. It avoids disrupting
+ the revision history of code lines. Diff should be kept minimal. For more
+ details, see our `pull request guide <https://odoo.com/submit-pr>`_.
.. warning::
- These guidelines are written with new modules and new files in mind. When
- modifying existing files, the original style of the file strictly supersedes
- any other style guidelines. In other words, never modify existing files in
- order to apply these guidelines, to avoid disrupting the revision history of
- each line. For more details, see our `pull request guide <https://odoo.com/submit-pr>`_.
+ When modifying existing files in **master (development) version** apply those
+ guidelines to existing code only for modified code or if most of the file is
+ under revision. In other words modify existing files structure only if it is
+ going under major changes. In that case first do a **move** commit then apply
+ the changes related to the feature.
Module structure
================