Feeds:
Posts
Comments

Archive for the ‘Development’ Category

As an important and much-requested follow-up to the community days, we have added a new Guidelines sections in the Community Book of the official OpenERP documentation.

The guidelines are divided up into four main parts, and will be fed incrementally as part of the process of reviewing contributions:

  • The Coding Guidelines contain a set of best practices for development, both Python programming guidelines (contextually applied to OpenERP) and specific best-practices related to OpenERP’s development framework.  It is structured as a series of of Dos and Don’ts showing good and bad practices extracted from actual OpenERP contribution code. The guidelines put the emphasis on code readability, reusability and security.
  • The Documentation Guidelines will feature general advice on contributing to OpenERP documentation, either functional / business documentation or technical documentation (including documenting the code). This should also include translations.
  • The Contribution Guidelines will help smooth the contribution processes for everyone by providing various checklists: things to verify before investing time on a specific contribution, how to develop, format, document and propose your contributions, etc. This should make the process of contributing and making the most of these contributions much easier and efficient.
  • The Usability Guidelines (or Useability) will describe the main decisions and conventions that have been followed for the design of OpenERP,  and that everyone should pay heed to when extending or improving existing features.

Work in progress
These new chapters of the documentation are being actively and incrementally written, so don’t be surprised to find empty sections at the moment! In fact this is the whole point: we want to write the guidelines using Community experience as source material, making sure to write a note in the guidelines about interesting or recurrent points. We don’t want to write upfront a long frozen list of rules. And by the way, being derived from the most active process at the moment, the Coding Guidelines are already shaping up quite nicely.

Target Audience
All developers and contributors should read and understand them, and everyone is welcome to comment and contribute to the guidelines, in order to make them a core reference for new and experienced contributors alike.

First guideline
Before you ask: you will find parts of the current version of OpenERP that do not follow all guidelines yet. The goal is not to rewrite these parts just for the sake of it, but to make sure that you do follow them for new contributions (which indeed requires improving the current parts whenever you happen to modify them for another purpose).

And remember, all of the above is true for members of the OpenERP Community, but even more for OpenERP’s own R&D teams!

Read Full Post »

Interesting code snippets/templates have been created by OpenObject/OpenERP developers and contributors:

  • A set of Python code snippets for OpenObject development with GEdit, linked in this blog (watch out for the GEdit bug on Ubuntu when importing the snippets, you may need to create $HOME/.gnome2/gedit/snippets beforehand)
  • Eclipse templates for Python and XML, hosted on Google Code

Read Full Post »