shopinvader / odoo-shopinvader

Odoo Modules. Sorry Magento, Shopinvader is coming
GNU Affero General Public License v3.0
121 stars 104 forks source link

Convention wording #1426

Open sebastienbeau opened 1 year ago

sebastienbeau commented 1 year ago

Hi @shopinvader/shopinvader-maintainers

In several module we mix some wording shipping/delivery and billing/invoicing.

I propose to always use

What do you think ?

Second point regarding the naming of "helper" for router. I see that we do not have define a clear convention.

I propose "name_of_module.service.name_of_service" ?

For example for cart it's give you

shopinvader_api_cart.service.cart

For addresses

shopinvader_api_address.service.delivery_address
shopinvader_api_address.service.invoicing_address

Thanks for you feedback I will clean the code depending on the decision.

sbidoul commented 1 year ago
  • delivery instead of shipping
  • invoicing instead of billing

Sounds reasonable. No strong opinion about that from my side.

We could add a glossary in the wiki or somewhere?

shopinvader_api_cart.service.cart

Currently it's shopinvader_api_cart.routers.cart. I remember we discussed that after Valencia. Have we written the rationale somewhere?

lmignon commented 1 year ago
  • delivery instead of shipping
  • invoicing instead of billing

:+1:

shopinvader_api_cart.service.cart

I would prefer to keep 'router' and 'helper' into the name. These odoo models are helpers for a specific pydantic router

-> shopinvader_api_cart.cart_router.helper: A helper model used by the endpoints of the cart_router.

sebastienbeau commented 1 year ago

ok for me. I will change the name of the existing model