summaryrefslogtreecommitdiff
path: root/doc/reference/guidelines.rst
AgeCommit message (Collapse)Author
2019-03-05[IMP] guidelines: remove actually wanted PEP8 optionsThibault Delavallée
Task-1817988 closes odoo/odoo#28714 Signed-off-by: Thibault Delavallee (tde) <tde@openerp.com>
2019-03-05[IMP] guidelines: improve xml ids naming sectionThibault Delavallée
* rewording of XML naming section * remove the convention of suffixing inherited XML ids with `_inherit_my_module, as the information is in the complete XML id name (prefixed by module name). This will avoid too long XML ids. * extend convention for the name of groups, views, ... Task-1817988
2019-03-05[IMP] doc: add guidelines for window actions namingThibault Delavallée
Rewording of "action" naming section. Task-1817988
2019-03-05[IMP] doc: rewrite part of module structure and js references guidelinesjem-odoo
This commit * removes deprecated guidelines for static file and assets struture; * fixes some typo and mistakes; * correctly links JS guidelines section; * adds a running example to ease understanding; * adds missing section about security files; * adds text blocks for each directory to show directly the expected result of each section; * perform some rewording; Thanks to @pedrobaeza for its review. Task-1817988
2019-01-08[FIX] doc: fix numbered list in guidelinesVeikko Väätäjä
Fix rst-formating for numbered list under heading "Inherited XML". closes odoo/odoo#30043
2018-10-09[IMP] doc: add guidelines about extandabilityMartin Trigaux
If the code is well written from the start, won't get so many hook requests closes odoo/odoo#27570
2018-10-10[IMP] doc: fields names shouldn't overwrite python methodsmreficent
The documentation should be an example of good practices closes odoo/odoo#27262
2018-10-09[REM] packaging: drop PyYAML dependencyAdrian Torres
Commit cf853a785ba4b533ddb2e8a717c9ffa6429e7b81 removed all yml tests and the yml import engine from Odoo forever, however PyYAML remains a dependency even though it's not used anymore. This commit removes any reference to this lib that could be found. closes odoo/odoo#27563
2018-09-25[IMP] doc: add selection method guidelinejem-odoo
Sometime, we need to get selection values from a method. Here are the guidelines about how to correctly name method and place it in the code.
2018-09-25[IMP] doc: adapt guidelines for 12.0jem-odoo
Odoo evolves and its coding guidelines too. This commit : - put some news guidelines, case to take into account when making new dev - update some guidelines that are difficult to applied in the real life - remove deprecated stuff (RML report, ...) - remove references to old api mainly, since all new dev must be done in new api Task #1817988
2018-07-17[IMP] doc: remove duplicate lineSébastien Theys
The same content is already there 2 lines above.
2018-04-18[REF] doc: adapt to mention scss instead of lessqsm-odoo
2018-04-05[DOC] doc: update/add documentation on js frameworkGéry Debongnie
The state of the JS documentation was quite sad, not updated in a long time. With this commit, we rework a lot of the JS doc. Most notably, we add a section 'Javascript Cheatsheet' (help on some common customization tasks) and rewrite the 'Javascript Reference' totally. Note that the JS reference page also contains a reference on all field widgets. This work is just the beginning, it is probably not complete, but at least we will have a foundation.
2018-03-16[FIX] doc: correct commit guideline formatMartin Trigaux
Github will automatically close the report is you use the format Closes #number No need to a leading # cf https://help.github.com/articles/closing-issues-using-keywords/ Add the meaning of [I18N] tag This commit is an example of a violation of the "one commit, one fix" principle
2018-03-13[IMP] doc: improve wording of guidelines introductionThibault Delavallée
Purpose of this commit is to clean a bit the wording and to clarify how to handle guidelines between stable and development versions.
2018-03-13[IMP] doc: improve guidelines related to Git and commit messagesThibault Delavallée
Purpose of this commit is to explain with more details how to write commit messages. Content of the Git section is also updated with last decisions and conventions.
2017-11-14[FIX] doc: remove reference to old vs new APIYenthe V.G
There is only one API, long live Odoo's API! Closes #20928
2017-10-02[MERGE] forward port branch saas-16 up to b3d0897f2d8Christophe Simonis
2017-10-02[MERGE] forward port branch 10.0 up to 2821730738aChristophe Simonis
2017-10-02[FIX] typo in guidelines fileVailiy Korobatov
2017-08-20[FIX] P3: correct more dict iterable builtins useOlivier Dony
Some bits posterior or leftover from fffaf735f58f1ac57781c095eb552de6d1fcdc47 See also parent commit.
2017-07-13[IMP] doc: remove <data> tag from xml filesMoisés López
Because now is no longer required Closes #18144
2016-12-09[IMP] doc: update guidelines.rstPatrik Lermon
Typo Closes #14652
2016-11-23[REM] workflow: Remove workflow engine, documentation and testsYannick Tivisse
2016-10-11[FIX] doc: building correctly autoclass referencesMartin Trigaux
2016-09-05[IMP] support v10 manifest file naming conventionOlivier Dony
- As of v10, manifest files should be named `__manifest__.py` - For backwards-compatibility, __openerp__.py manifest files will still be supported for the time being - Limited refactoring, to add support for the 2 different naming conventions - All textual references to __openerp_.py updated in documentation and examples
2016-05-19[IMP] doc : add python idioms and odoo specific coding guidelinesJérome Maes
- add python idioms - odoo specific guidelines (for ORM, translations, ...) inspired from old guidelines v6.0 - some other best pratices
2016-05-19[IMP] doc : expand the coding guidelinesJérome Maes
- correct typos - clarify some points, according to the community comments - precise the xml notation : record tag vs act_window/menuitem/... tags - add organization of report, wizard, data/demo, ... (directories and naming conventions) - new conventions for 'symbols' - ... Thanks to @rim-odoo for its grammar extremist review, and @tde-banana-odoo for our long debates about wizard conventions.
2016-04-26[IMP] doc: add guidelines warningMartin Trigaux
To prevent huge chunk of modifications for styling reasons (e.g. mass PEP8 commits)
2016-04-26[IMP] doc: simpler coding: utf-8Martin Trigaux
According to PEP-263, the -*- is just a variant "using formats recognized by popular editors".
2016-04-18[FIX] doc: deprecated statusbar_colorMartin Trigaux
Can still be mentionned in documentation but should not be used in example.
2016-04-12[FIX] doc: Improve englishYenthe
Some rephrasing to slightly improve the docs. Closes #11652
2015-07-07[FIX] doc: incorrect role syntaxXavier Morel
2015-07-07[IMP] doc: grammar and readabilityJ Bradshaw
Backport of most of #6827 by J Bradshaw with additional modifications (and some reverts) during review. closes #6827
2015-07-07[ADD] doc: new themeXavier Morel
Pretty much completely rewritten theme with custom HTML translator and a few parts of the old theme extracted to their own extensions. Banner images thought not to be that huge after all, and not worth the hassle of them living in a different repository. co-authored with @stefanorigano
2015-03-31[ADD] doc : odoo official coding guidelines. This is the first version of ↵Jérome Maes
the guidelines. Discussions and conventions are not frozen.