Module Scaffolding and Codebase Governance Standards

1. Overview & Business Value#

This comprehensive operational guide details the architecture, business workflows, configuration parameters, and execution steps for Module Scaffolding and Codebase Governance Standards within SmartERP.

Every custom addon in the SmartERP monorepo must adhere to strict modular scaffolding conventions and the established inheritance ladder:

$$\text{EXTEND} > \text{REUSE} > \text{CONFIGURE} > \text{REFACTOR} > \text{CREATE NEW}$$

Standard Module Directory Layout#

addons/my_custom_module/
├── __init__.py
├── __manifest__.py
├── models/
│   ├── __init__.py
│   └── my_model.py
├── views/
│   ├── my_model_views.xml
│   └── my_menus.xml
├── security/
│   ├── ir.model.access.csv
│   └── my_security_rules.xml
├── tests/
│   ├── __init__.py
│   └── test_my_feature.py
└── data/
    └── default_records.xml

{screenshot:module-scaffolding-and-standards-overview-dashboard}

2. Prerequisites & Security Access Groups#

• Required Modules: base, web, smarterp_core
• Security Groups:
  • Enterprise Developer (Technical ID: base.group_no_one)
  • System Administrator (Technical ID: base.group_system)
• Master Data Dependencies: Established local development toolchain (Python 3.12+, PostgreSQL 16), cloned repository (smarterp-platform), and valid database configuration.

3. Step-by-Step Configuration & Execution#

Step 1: Navigating to the Module Interface#

1. Open your terminal or development environment in the repository root (/Users/danielbekele/smarterp-platform).
2. Activate your dedicated Python virtual environment.
3. Verify Git branch status: git status.

{screenshot:module-scaffolding-and-standards-app-switcher-navigation}

Step 2: Creating and Parameterizing Records#

1. Execute development commands or scaffolding templates.
2. Define mandatory manifest parameters:
   • name (Mandatory): Descriptive module title.
   • version (Mandatory): Standard semantic versioning (e.g. 19.0.1.0.0).
   • depends (Mandatory): Explicit list of upstream module dependencies.
   • license (Mandatory): Open source or proprietary enterprise license identifier.
3. Configure optional parameters: data files, security ACLs, and automated test cases.

{screenshot:module-scaffolding-and-standards-record-creation-form}

Step 3: Validating and Processing Transactions#

• Execution & Testing: Run unit tests via odoo-bin -i <module_name> --test-enable --stop-after-init.
• Quality Verification: Ensure test suite passes with zero errors and zero unhandled warnings.

{screenshot:module-scaffolding-and-standards-transaction-processing-state}

4. Advanced Configuration Points#

• Automated Actions & Scheduled Tasks (Crons):
  • Developer: Module test runner trigger (base.ir_cron_run_tests)
  • System: Automated cache cleanup (base.ir_cron_cache_cleanup)
• Custom Print Templates & Reports:
  • Technical Data Dictionary Specification
  • Code Quality & Test Coverage Dossier
• Multi-Company Rules: Record-level security isolation under Company 1 (Ashewa Technology Solutions S.C.).

5. Comprehensive Troubleshooting Matrix#