vval - technical onboarding #623
Conversation
|
|
vval-odoo
force-pushed
the
18.0-realEstate-module-vval
branch
7 times, most recently
from
bec23fa to
c769eb4
Compare
Module to handle real estate properties and salesflow.
This module allows to create invoices directly from the estate property form when the property has been marked as 'sold'.
vval-odoo
force-pushed
the
18.0-realEstate-module-vval
branch
from
ed3d58f to
d18afcc
Compare
| @@ -0,0 +1 @@ | |||
| from . import models | |||
There was a problem hiding this comment.
Commit message:
if you use [ADD], which is the right thing to do in this case, you already say that you add a module, so no need to make it your commit title. Explain what the module does in few words, beginning by a verb.
"[ADD] estate: handle real estate properties and salesflow"
Then in description, you can describe what features and capabilities the module have
and even list all the models used to handle the business cases. What do what and how they interact.
Basically, when reading commit message, you don't need to read the code to know how the module works. Or reading commit message will help you understand the code.
Better reading 10 lines of real words than 250 lines of code.
The goal of the commit message is mainly to help future debugging or refactoring or functionality rework, when you try to find why a certain line has been added to the code base, you read the commit message to get the context in which the commit content has been added. Knowledge is power. Better too much info than not enough :)
| @@ -0,0 +1 @@ | |||
| from . import models | |||
There was a problem hiding this comment.
Commit message:
[ADD] estate_account: allows to create invoices for 'sold' properties
then add details
| @@ -0,0 +1,4 @@ | |||
| { | |||
There was a problem hiding this comment.
You miss the version, summary, description, category, application=False, installable=False (because automatically installed when both accounting and estate module will be installed)
author and license.
apply this in the other commit as well
No description provided.