Modules - Rules for community modules: Difference between revisions

m
Tag: 2017 source edit
Tags: Mobile edit Mobile web edit Advanced mobile edit
 
(4 intermediate revisions by the same user not shown)
Line 5: Line 5:


= [[File:Art.png]] Introduction =
= [[File:Art.png]] Introduction =
This page contains the rules defined for all modules integrated into the community repository.
This page contains the rules defined for the management of modules integrated into the official Community repository.
https://github.com/Dolibarr/dolibarr-community-modules
https://github.com/Dolibarr/dolibarr-community-modules


Line 11: Line 11:
The Dolibarr board is the owner of the community repository.
The Dolibarr board is the owner of the community repository.


Modules integration requests must be done by doing a Pull Request. The Dolibarr foundation board will merge the first pull request if accepted and if the module is hosted on the repository itlsef, will grant the permission to merge Pull Request to the initial author of the module so he can assume its responsability of merging following Pull Requests as explained into the Maintenance chapter.
Modules integration requests must be done in 2 steps:
 
1 - publish the module for free on dolistore for 6 month.
 
2 - after this delay, check your criteria match the rules for integration as a community module (see next chapter) and do a Pull Request. The Dolibarr foundation board will merge the first pull request if accepted and if the module is hosted on the repository itlsef, will grant the permission to merge Pull Request to the initial author of the module so he can assume its responsability of merging following Pull Requests as explained into the Maintenance chapter.


The Dolibarr foundation board should decide if a module is integrated or not according to all the following rules...
The Dolibarr foundation board should decide if a module is integrated or not according to all the following rules...
Line 46: Line 50:
Modules must follow the same quality and coding rules than the Dolibarr project (See [[Language_and_development_rules]]), except the '''minimal and maximal PHP version''' (See chapter "Compatibility") that can be diffrent than the Dolibarr official range.
Modules must follow the same quality and coding rules than the Dolibarr project (See [[Language_and_development_rules]]), except the '''minimal and maximal PHP version''' (See chapter "Compatibility") that can be diffrent than the Dolibarr official range.


Modules are allowed to be compatible with a limited list of Dolibarr versions.
Community Modules are allowed to be compatible with a limited list of Dolibarr versions.


Of course, the licence of the module, as a derivative work of Dolibarr that is licensed under GPL v3+, should use the GPL license or any OSI license compatible with GPL v3+.
Of course, the licence of the module, as a derivative work of Dolibarr that is licensed under GPL v3+, should use the GPL license or any OSI license compatible with GPL v3+.