Openbravo Forge End of Life Notice

Dear Openbravo Forge User,

Because of continued very low usage we decided to stop the following services on 31st of August 2017:

In case of question: webmaster "at" openbravo.com
View source | Discuss this page | Page history | Printable version   

Openbravoforgesupport/Help/Usage Modules

Contents

Introduction

This document describes the best practices and polices to apply in Openbravo Forge to develop and organize an extension. These are a simplified version of the same guidelines that we use to develop Openbravo ERP core project plus some specific guidelines for the Openbravo Forge usage.

Let's start by defining some key concepts:

Documentation

Before starting any development, we recommend to create a set of documentation that will guide the development and will help users in the future to understand what the module achieves.

We recommend to have the following documentation:

You are encouraged to follow the Development Documentation Style Guide article for structuring your development documentation. You can take a reference the Human Capital Module to better understand how to organize this documentation.

Source Control System

Developers can use the source control system of their choice. Openbravo Forge provides Subversion as source control system. The instructions given in this section apply only to Subversion, including the recommended repository structure for Openbravo modules. You can leverage on your source control system specific features for branching and tagging.

The following is a list of common terminology used when working with Subversion:

Recommended Repository Structure for Openbravo Modules

Openbravo recommends following structure when organizing the source code of your module:

When developing a module, the main development activity occurs in the main development trunk.

All developers commit the changes against this branch. When a version is reach, a tag should be done.

If you want to work with a stable version you usually download the tagged version (a released version) and if you want to follow the development you download trunk.

We recommended the Version Control with Subversion free on-line book.

Registering Modules

As a prerequisite to publish modules into the Central Repository, you have to first register them.

This a list of recommendations when registering modules within the Central Repository from Openbravo ERP:

Creating Packs

Packs

When creating a pack project in Openbravo Forge, we recommend to enable the following services in Openbravo Forge:

We suggest to discard the usage of the rest of the services that the Forge provides.

Additionally, we recommend:

Module

When creating a module in Openbravo Forge, we recommend to enable the following services:

For modules, we suggest to discard the usage of the rest of the services that the Forge provides.

Additionally, we recommend:

Template

A template is a configuration file plus a collection of packs and modules. We recommend to enable the following services in Openbravo Forge:

Additional Information

Retrieved from "http://forge.openbravo.com/plugins/mwiki/index.php/Openbravoforgesupport/Help/Usage_Modules"

This page has been accessed 37,209 times. This page was last modified on 1 April 2010, at 07:56. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.