Translations by Xavier (Open ERP)

Introduction

The Contribution Guide is intended as an overview and sometimes even a reference on the organization of the OpenERP Community and eco-system. It serves as a quick start helper document for new members of the OpenERP Community, but should prove quite useful to more experienced members as well, as it is frequently updated to follow the latest evolutions in the Community.

A few examples of the important topics you will find in the Contribution Guide:

A description of the different Community tools in use ;

A description of the various Community actors and teams ;

An explanation of the current Community Processes ;

A set of incrementally written guidelines, dedicated to each major contribution area.

Of course this documentation is not frozen, and one of the first areas everyone is invited to contribute to is the documentation itself!

In order to build the best enterprise management software ever created, we need to foster a perfect collaboration between all OpenERP actors. By joining the contributions and feedback from the Community, with the market knowledge and experience of Partners and the quality control and vision of the Publisher, we get the benefits of all worlds and create a great product for the Customers. This is the recipe of OpenERP's development and business model.

Launchpad, Community Platform

We use `Launchpad.net <https://launchpad.net>`_, an open source project management and collaboration platform, as our code hosting facility and community platform. All OpenERP-related projects are aggregated under the meta `OpenObject <https://launchpad.net/openobject>`_ project group.

OpenERP more specifically uses the following Launchpad features, as further detailed in this guide:

Anyone in the OpenERP Community is free to use any of the above features. The only requirement is to `sign up on Launchpad <https://login.launchpad.net/+new_account>`_ and join the `OpenERP Community <https://launchpad.net/~openerp-community/+join>`_ team, which only requires a few clicks.

Some additional team memberships are required in order to accomplish specific tasks, as explained in the corresponding sections of this Contribution Guide.

Working in teams

People

Contributors

The community team is available on launchpad: https://launchpad.net/~openerp-community

Expert Teams

Translators team

The Planets and announcements

What are the planets ?

Writing Guidelines

Bazaar, the version control system

Installing Bazaar

Then, do the following

If you experience problems with Bazaar, please read the :ref:`bazaar-faq-link` before asking any questions.

Quick Summary

To download the latest sources and create your own local branches of OpenERP, do this::

This will download all components of openerp (server, client, addons) and create links of modules in addons on your server so that you can use it directly. You can change the bzr_set.py file to select what you want to download exactly. Now, you can edit the code and commit in your local branch.::

If your changes fix a public bug on launchpad, you can use this to mark the bug as fixed by your branch::

How to get the latest trunk source code

How to commit Your Work

Use Case Developers

Commit Guidelines

Write a helpful commit message

Avoid big commits

Developing modules

Getting Sources

Coding Guidelines

Organisation of files in modules

The structure of a module should be::

Security

Reporting

Naming Convention

Dependencies

Module Content

Menus

Order of the menus

Common Mistakes