Changes

Jump to navigation Jump to search

Developer FAQ

1 byte removed, 10 years ago
m
no edit summary
[[Category:FAQ EN]]
{{TemplateDocDevEn}}
 
= How to be an official developer =
 
In the galaxy of the project Dolibarr, there are several stakeholders at different levels / grades.
The number of developers is important and 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 code).
For this reason, the write access on the source (CVS) 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 CVS write access for some time.
 
The ranks of contributors to the project Dolibarr are:
 
== * Soldier ==
 
The first thing that a person willing to help is to be familiar with the rules and standards developments.
Reading the [[Developer documentation]], you have shown sufficient willingness to become automatically '''Soldier''' (grade level '''Soldier'''). And just read is not the easiest ...
 
This grade is obtained without validation higher. 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 [[Developer FAQ#Submit a patch, work and help on Dolibarr development|Submit a patch, work and help on Dolibarr development]] for the procedure) or on the forum (Preferred Mailing List).
 
At your first accepted patch (included in CVS 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 more we will be strong.
The hunters are the main force of the alliance Dolibarr.
 
A list of Dolibarr contributors with this grade is available on page [[:Category:Chasseur]]
 
== * Z-6PO ==
 
If you are fluent in a language not or poorly translated into Dolibarr, a '''Jedi''' or '''Yoda''' will grant CVS access to your Savannah login, so you can make changes and commits directly into the CVS of the project (See [[Developer_FAQ#Get.2Fupdate_the_development_CVS_version|Get/update the development CVS version]] to know how to use it). But commits must be limited to changes for translations purposes.
This grade can be obtained quickly enough. Just ask it on mailing list.
 
A list of Dolibarr contributors with this grade is available on page [[:Category:Z-6PO]]
 
== * Admiral ==
 
Only after a variable time (which can be very long) to the rank of a Fighter, and many patches of suitable quality had been sent, a Yoda in place allows you to make CVS commits extended for cause of any patch.
You have become a '''Admiral''' of the alliance Dolibarr.
 
This title can't be asked, it is obtained by a decision or proposal of a '''Jedi''' or '''Yoda''' who believes that you have submitted enough patch to be a serious '''Admiral'''.
An '''Admiral''' CVS access, however, must be used to commit translations or bug fixes reported on Savannah or forum (such as personal fixes or fixes submitted by a '''Fighter''').
So all CVS commits you do must necessarily include in the description (the commit log field), the issue of Savannah 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 ==
 
This is even after a variable time (probably the longest of all) to the rank of Admiral, and the quality of the patch that was sent is satisfactory, that a Yoda will tell you that you are authorized to perform commits without restrictions, included 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 is 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 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 is some parasites 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 Dark Vador 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 the development CVS version =
This process was built to work whatever is start step and can be run and rerun several times with no risks.
 
= Start a development =
 
Read first '''completely''' the [[Developer documentation]] to know all rules a developer must respect.
You can also read following FAQ.
= How to create a new skin =
= How to package and deploy a module =
See page [[Module development]]
 
= How to be an official developer =
 
In the galaxy of the project Dolibarr, there are several stakeholders at different levels / grades.
The number of developers is important and 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 code).
For this reason, the write access on the source (CVS) 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 CVS write access for some time.
 
The ranks of contributors to the project Dolibarr are:
 
== * Soldier ==
 
The first thing that a person willing to help is to be familiar with the rules and standards developments.
Reading the [[Developer documentation]], you have shown sufficient willingness to become automatically '''Soldier''' (grade level '''Soldier'''). And just read is not the easiest ...
 
This grade is obtained without validation higher. 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 [[Developer FAQ#Submit a patch, work and help on Dolibarr development|Submit a patch, work and help on Dolibarr development]] for the procedure) or on the forum (Preferred Mailing List).
 
At your first accepted patch (included in CVS 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 more we will be strong.
The hunters are the main force of the alliance Dolibarr.
 
A list of Dolibarr contributors with this grade is available on page [[:Category:Chasseur]]
 
== * Z-6PO ==
 
If you are fluent in a language not or poorly translated into Dolibarr, a '''Jedi''' or '''Yoda''' will grant CVS access to your Savannah login, so you can make changes and commits directly into the CVS of the project (See [[Developer_FAQ#Get.2Fupdate_the_development_CVS_version|Get/update the development CVS version]] to know how to use it). But commits must be limited to changes for translations purposes.
This grade can be obtained quickly enough. Just ask it on mailing list.
 
A list of Dolibarr contributors with this grade is available on page [[:Category:Z-6PO]]
 
== * Admiral ==
 
Only after a variable time (which can be very long) to the rank of a Fighter, and many patches of suitable quality had been sent, a Yoda in place allows you to make CVS commits extended for cause of any patch.
You have become a '''Admiral''' of the alliance Dolibarr.
 
This title can't be asked, it is obtained by a decision or proposal of a '''Jedi''' or '''Yoda''' who believes that you have submitted enough patch to be a serious '''Admiral'''.
An '''Admiral''' CVS access, however, must be used to commit translations or bug fixes reported on Savannah or forum (such as personal fixes or fixes submitted by a '''Fighter''').
So all CVS commits you do must necessarily include in the description (the commit log field), the issue of Savannah 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 ==
 
This is even after a variable time (probably the longest of all) to the rank of Admiral, and the quality of the patch that was sent is satisfactory, that a Yoda will tell you that you are authorized to perform commits without restrictions, included 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 is 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 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 is some parasites 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 Dark Vador per year ...
 
= Current team =
See page [[Dolibarr Project]] to know list of current people that work on Dolibarr, with their current grade.
= How to be informed on news and what happens on Dolibarr project ? =
See page [[FAQ How to be informed about Dolibarr project ?]]

Navigation menu