Odoo-Build/AGENTS.md

AGENTS.md

General agent guidance

This section outlines the universal rules and expectations for any LLM agent working within this repository.

Safety and Quality First: The highest priority is to produce secure, well-documented, and high-quality code. Do not introduce vulnerabilities, hardcoded secrets, or unreadable code.

Propose a Plan: For any new task, first provide a brief plan of action. This plan should clearly outline the intended changes and the rationale behind them.

Maintain Context: Before making any changes, an agent must read and understand the relevant files, including the project's main documentation and existing code structure.

Be Sparse: Only introduce new code if needed. Comment only what is worth commenting. When testing focus on the business use case.

Project structure

• task: The main entry point. It manages the entire project.
• addons/:
• bin/: Contains helper scripts for the task file.
• enterprise/: Here is the Odoo enterprise source code.
• images/: This folder contains the build files for multiple Docker images.
  • odoo/: This is the main image.
• odoo/: Here is the Odoo enterprise source code.
• revisions/: Generated Odoo revision files.
• snippets/: Big folder with XML-edit files. Ignore.
• templates/: Templates for Odoo modules and git repos.
• themes/: Official Odoo website themes.

Environment & tooling

Taskfile

This project uses the https://taskfile.build/ standard.

The ./task file is a bash script that provides all functions necessary to work with this project.

Always try to run a command with the ./task file script.

Common tasks

Install

Install project dependencies.

task install

Module Development

To create module code use the task generate-module-* commands.

task generate-module-views addons/project/project_sprint project.sprint

If the database is running (task start db) then install the module like this:

task init-module addons/project/project_sprint

Use lint-module to lint the module code. You can also run the task lint in the module repo folder.

You can also uninstall a module.

task uninstall-module addons/project/project_sprint

When creating new controllers in Odoo modules, ensure to:

1. Import the controller in the module's __init__.py file (e.g., from . import controllers)
2. Inherit from appropriate parent classes (e.g., WebsiteForm for website form controllers)
3. Use proper route decorations and ensure routes don't conflict with existing ones
4. Test the controller by checking that the route is properly registered and accessible

Coding conventions

Bash

The following guideline is heavily based on the Bash Style Guide | ysap.sh, which should be considered the primary reference for style. Adhere to the following principles to ensure scripts are safe, predictable, and maintainable.

Shebang: Start scripts with #!/usr/bin/env bash for portability.

Quoting: This is critical.

• Use double quotes " for strings that require variable expansion.
• Use single quotes ' for all other strings.

Always quote variable expansions "$var" to prevent word-splitting and globbing issues.

Variables: Distinct between local and environment vars.

• Use local for all variables inside functions.
• Use lowercase names for local variables (e.g., buildx_output).
• Use uppercase names for environment variables (e.g. export BUILDX_PLATFORM)

Functions:

• Do not use the function keyword.
• Use my-func() { ... } syntax.
• Function names are in kebab case.

Conditionals:

• Always use [[ ... ]] for conditional testing, not [ ... ] or test.
• Use ((...)) for arithmetic comparisons (e.g., ((a > b))).
• When replacing [] with [[]] make sure to escape the brackets. The [] is a regex filter.

Command Substitution:

• Always use $(...) for command substitution, not backticks.

Arrays:

• Use Bash arrays to manage lists of items instead of space-separated strings.
• Iterate over arrays using for item in "${my_array[@]}"; do ... done.

Avoid External Commands:

• Use Bash's built-in parameter expansion for string manipulation (e.g., ${var/foo/bar}).
• Use globbing (*) to iterate over files, not ls.
• Avoid cat when a command can read a file directly (e.g., grep "pattern" file).

eval: Never use eval.