Confirmation of good practice on the name of the modules.

[Thierry Bruyere]

The name of a module is composed of:

The module name
The prefix for the module name
The package name

The directory name will be equal to the name of the module (without the prefix)

The package name is only to identify the package in the installation module in tryton client.

If I create a new module for undeveloped functionality in tryton.
The module name = functionality as prefix with my company (which creates the module)

example:

Module Name: request_for_quotation
Prefix: saluc
The package name: saluc_request_for_quotation
Directory: request_for_quotation

If I modify an existing module in tryton.
The module name will be defined with the functionality added to the basic module.
The prefix will be the name of my company (which creates the module)

example:

Added a feature to put a picture on the product

Module Name: product_picture
Prefix: saluc
Name paquest: saluc_product_picture
Directory: product_picture

Questions :

If I want to modify an existing module to only change the workflow. How to name the module?

example:

Adding a transition in the purchasing module.

Module Name: saluc_purchase
or
Module Name: purchase_saluc

Do I have put something for the prefix?

[Cédric Krier]

On 2016-04-04 08:03, Thierry Bruyere wrote:
> The name of a module is composed of:
>
> The module name
> The prefix for the module name
> The package name
>
> The directory name will be equal to the name of the module (without the
> prefix)
>
> The package name is only to identify the package in the installation module
> in tryton client.
>
> If I create a new module for undeveloped functionality in tryton.
> The module name = functionality as prefix with my company (which creates
> the module)
>
> example:
>
> Module Name: request_for_quotation
> Prefix: saluc
> The package name: saluc_request_for_quotation
> Directory: request_for_quotation

It is probably linked to purchase topic. So having a prefix for it is
good. Also it is always good if you plan to propose the module for
inclusion to get feedback about the name early because it is a little
bit painful to rename it after.

> If I modify an existing module in tryton.
> The module name will be defined with the functionality added to the basic
> module.
> The prefix will be the name of my company (which creates the module)
>
> example:
>
> Added a feature to put a picture on the product
>
> Module Name: product_picture
> Prefix: saluc
> Name paquest: saluc_product_picture
> Directory: product_picture

Yes it is the suggested way. By the way, it is not necessary to use the
company as prefix, it could be just project code name.

> *Questions* :

>
> If I want to modify an existing module to only change the workflow. How to
> name the module?
>
> example:
>
> Adding a transition in the purchasing module.
>
> Module Name: saluc_purchase
> or
> Module Name: purchase_saluc
> Do I have put something for the prefix?

Usually at B2CK, we create a specific module with all the customization
for one installation (named after the installation). But this is really
a matter of personal taste. But it is also important to not have too
much modules because it complexify the stack.

--
Cédric Krier - B2CK SPRL
Email/Jabber: cedric...@b2ck.com
Tel: +32 472 54 46 59
Website: http://www.b2ck.com/