Developer FAQ

From Dolibarr ERP CRM Wiki
Revision as of 15:56, 5 November 2011 by Simnandez (talk | contribs) (Reverted edits by MarvafWash (talk) to last revision by Eldy)
Jump to navigation Jump to search

This page contains some frequently asked questions related to Dolibarr development. For frequently asked questions on other topics, read page User FAQ.

How to be an official developer

In the galaxy of the Dolibarr project, there are several actors with different levels / grades. The number of developers is important so contributions and changes, for any project that wants to reach a certain level of quality, must be controlled and validated (both for functional needs and for coding). For this reason, the write access on the source (GIT) is limited and governed by an organization that is described in the following. Each developer has a grade depending on seniority and the past. The level of authorization of a person on the project increases with the stages of promotion in grade.

The course of a Dolibarr developer passes through these steps, which are classified by a title familiar to fans of science fiction. Here are the steps. It is important to understand that this organization has the sole purpose of improving the quality of Dolibarr and it is necessary that it is rigorously used. So do not be offended if, as a developer, you can not have a GIT write access for some time.

The ranks of contributors to the Dolibarr project are:

* Soldier

The first thing that a person willing to help needs to be familiar with the rules and standards developments. By reading the Developer documentation, you have shown sufficient willingness to automatically become Soldier (grade level Soldier). Most people that are interested in Dolibarr development are in this category.

This grade is obtained without higher validation. It is a grade of principle, to start.

Due to the nature of this level, it is not possible to establish a list of all Dolibarr actors with this grade (list always changing and too long).

* Fighter

The next step is to submit your first patch, starting with simple ones, on the dev Mailing List (see chapter Submit a patch, work and help on Dolibarr development for the procedure) or on the forum (Preferred Mailing List).

You can find easy to do patches on the TODO tracker: https://github.com/Dolibarr/dolibarr/issues

Easy to start tasks have the property "Task opened to external developers" set to "yes". If the value is "no", forget it, this means the task will be processed by a Jedi-grade developer.

At your first accepted patch (included in GIT by an Admiral, Jedi or Yoda), you automatically enter into the family of Fighters of the Dolibarr alliance.

The number of hunters is not limited. The more we are, the stronger we will be. The hunters are the main force of the Dolibarr alliance.

A list of Dolibarr contributors with this grade is available on page DevCamp Montpellier April 2013 Organization

* Z-6PO

If you are fluent in a language not present or poorly translated into Dolibarr, a Jedi or Yoda will grant GIT write access, so you can make changes and commits directly into the GIT sources of the project. Create your git account then ask for write access on Dolibarr dev mailing-list (https://savannah.nongnu.org/mail/?group=dolibarr) to claim to be part of project as a Z-6PO for your language.

You can also read page Get/update project sources to know how to use the GIT server to commit your changes on language files. But commits must be limited to changes for translations purposes. This grade can be obtained quickly enough. Just ask for it on mailing list.

A list of Dolibarr contributors with this grade is available on page Category:Z-6PO

* Admiral

Only after you've held the rank of Fighter for a variable time (which can be very long), you've submitted many patches of suitable quality, a Yoda in place allows you to make GIT commits extended for cause of any patch. You have become an Admiral of the Dolibarr alliance.

This title can't be requested. It is obtained by a decision or proposal of a Jedi or Yoda who believes that you have submitted enough patches to be a serious Admiral. An Admiral GIT access, however, must be used to commit translations or bug fixes that are reported on bug tracker (https://github.com/Dolibarr/dolibarr/issues) or forum (such as personal fixes or fixes submitted by a Fighter). So all GIT commits you do must necessarily include in the description (the commit log field), the issue of bug corrected or the title of the forum message indicating the problem. Only a translation escapes this constraint (no restrictions for translations). Failure to observe this constraint may lead to downgrade to the rank of Fighter. For submission of new features, an Admiral must necessarily proceed on the principle of patches sent to the ML.

Obtaining the rank of Admiral is as rare as limited. Dolibarr quality can not be achieved without a limited number of Admirals, but this is still compatible with having a very high number of developers (Fighters), contributing through patches.

A list of Dolibarr contributors with this grade is available on page Category:Admiral

* Jedi

Only after holding the rank of Adminral for a variable time (probably the longest of all), and the quality of GIT bug fixes or patches sent is satisfactory, a Yoda will tell you that you are authorized to perform commits without restrictions, including new features. However you will still have to explain to all Yoda what you want to do to give back a "go". You will then become a Jedi. There may be temporary restrictions on commits, defined by a Yoda, for example due to a close release.

This title can't be asked, it is obtained by a proposal of another Jedi or by a Yoda.

This privilege is exceptional. Dolibarr quality can not be achieved without a limited number of Jedi, but this is not compatible with a high number developers (Fighters) contributing with patches.

A list of Dolibarr contributors with this grade is available on page Category:Jedi

* Yoda

There are about 1 to 5 Yoda. It's the overall management of project development. This ranking is obtained by inheritance or vote. For example, it can be achieved after a vote organized by a Yoda making retirement.

A list of Dolibarr contributors with this grade is available on page Category:Yoda

* And Darth Vader?

There are some parasitic people that pollute the forum or mailing-list with aggressive messages, which slows the development of Dolibarr rather than offering constructive criticism to help improve. Some are very strong bad liver and bad tone. Such people are Darth Vaders. Fortunately, statistically, there is only one or two Darth Vader per year ...

Current team

See page Dolibarr Project to know list of current people that work on Dolibarr, with their current grade.

Start a development

Read first completely the Developer documentation to know all rules a developer must respect. You can also read following FAQ.

Get/update project sources

See page FAQ Get,update GIT project sources.

How to create a new skin

For this, see page Skins

How to develop my own menu system

For this, see page Menus system

How to develop my own module

To develop your own numbering module, see Create numbering module.

To develop your own document model, PDF or other, see Create a PDF document template or Create an ODT document template.

To develop your own business module (screens, tables), see page Module development.

How to add/complete a translation

For this, see page Translator documentation

Change my numbering system after start

If the new numbering system does not conflict with the old one, to change the numbering rule, just go to menu Setup - Modules - Invoice setup and choose the new numbering rule in the list. If the new rule can create conflicts with old one, it will be necessary to rename old existing references. This can be done by a SQL request. For example, to go from numbering module Jupiter (FYYYYMM99) to Terre (FAYYMM-999), you can run the following request:

update llx_facture set facnumber=concat('FA',substr(facnumber,4,4),'-',substr(facnumber,8))
where facnumber like 'F%' and facnumber not like 'FA%';

For example, to rename references from model FAYYMM999 to Terre (FAYYMM-999), you can run the following request:

update llx_facture set facnumber=concat('FA',substr(facnumber,3,4),'-',substr(CONCAT('0000',substr(facnumber,7)),-4))
where facnumber like 'FA%' and facnumber not like '%-%';

Submit a patch, work and help on Dolibarr development

If you want to know what you can do to start or help Dolibarr development, read instead chapter Developer_FAQ#How_to_be_an_official_developer. If you already read it and want to distribute a patch, this chapter is for you.

With a GIT account

For the moment, GIT write access are restricted (number of commits is already active). If you have this access, you can use it, but if and only if you use it to commit changes you are granted to with your developer grade (See Developer FAQ#How to be an official developer for information on different grades). If you don't have GIT access (your grade must be Soldier or Fighter), it is necessary to follow the following steps...

If you have a GIT write access, see #Get/update project sources for information to use GIT.

If you don't have a GIT write access, you can make a "Push Request" from GitHub. Otherwise, you can also follow next process.

With no GIT account

With no GIT write access, it is necessary to generate and send by mail a patch file to the developer mailing-list dolibarr-dev (https://savannah.nongnu.org/mail/?group=dolibarr). This is how to generate a patch file:

For all OS: Logo windows.png Logo ubuntu.png Logo apple.png

This is the best method to work to build such a patch file:

- First, you must have a directory containing last reference version of Dolibarr (the result of a GIT update or simply the files resulting of uncompressing a dolibarr.tgz snapshot). We will call this directory old_dir. You can get this snapshot for current development version on Dolibarr official web site in download area - development version. Warning: You must get "last development source code" and not "last stable version code" to build your patch, or your patch will be obsolete before you start to work on it !

- Then, you must have a second directory, from same source, that will contains Dolibarr directories, in which you will make all you files. We will call this directory new_dir.

To build the patch file, you must launch the diff command (available on all Linux, provided with cygwin under Windows) with the following command:

diff -BNaur --exclude=CVS --exclude="*.patch" --exclude=".#*" --exclude="*~" --exclude="*.rej"
     --exclude="*.orig" --exclude="*.bak" --exclude=conf.php --exclude=documents  
     old_dir new_dir  > mypatch.patch

A ksh script to run this command is available in directory build/patch. Send your patch on Dev Mailing List to the address dolibarr-dev@nongnu.org (after subscribing to it). Inclusion of your patch is however not guaranted, no more than delay. But if patch is realized strictly with using this process, there is a very important probability (near 100%) that it will be at least "tested" (if patch is not done this way, chance are simply null).

For Windows: Logo windows.png

If you work on Windows, another method (not so nice than previous) is also possible. Install the open source compare tools called Winmerge (this tool is able to build patch with format diff -Naur). Then compare with WinMerge the reference file and modified file and choose in menu "Tools - Generate patch". Add an output filename like "mypatch.patch", click on box "Append" and choose option "Format Unified". Then click on "Ok". Eventually restart for each modified file. Finally, you will get a file mypatch.patch that contains all changes with goode format.

Test/Apply a patch

If you want to apply a patch file on an old version to have a new one modified by the path file, this is possible with the patch tool. Imagine you have on non modified version somewhere on a server. Put you patch file into the root directory. Go into this root directory then launch the command:

patch -u -p0 -d . < mypatch.patch

For information: -p0 is to use full path of files defined in patch file to locate them on your disk (-pn will remove the n first levels of directories) -d define the relative path do directory to patch. < is to provide source file name to use (patch must have format previsouly defined) -u is to tell that patch has unified format

Send patch by mail

Once patch file is built and successfully tested, you must submit file to the Dolibarr mailing list dolibarr-dev (See here for this https://savannah.nongnu.org/mail/?group=dolibarr). This mailing list is read by most Dolibarr developers, however we can't say when patch will be processed nor that if it will be included. It depends on quality of patch and priorities of moment. Some patches are added several months after beeing subimtted.

How to package and deploy a module

See page Module development.

This process works also to generate a package to submit it on the http://www.dolistore.com market place.

How to be informed on news and what happens on Dolibarr project ?

See page FAQ How to be informed on news about Dolibarr project

Migrate my Mysql database to PostgreSQL

See page FAQ Migrate my Mysql database to PostgreSQL