Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (36 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

47 lines (36 loc) · 1.8 KB
Raw

Contributing to roekish-addons

Thanks for your interest. This repository holds our open-source reference Odoo modules; contributions that improve them — or add new, genuinely reusable modules — are welcome.

Ground rules

  • Target Odoo 18.0 Community, PostgreSQL 16. Don't depend on Enterprise-only modules.
  • LGPL-3 only. By contributing you agree your contribution is licensed under LGPL-3.0-or-later. New .py files must carry the standard header: 
    # Copyright <year> Roekish
# License LGPL-3.0-or-later (https://www.gnu.org/licenses/lgpl-3.0)
  • No client data. Never commit real client names, data, credentials, SIRET/ VAT numbers, or .env files. Demo data must be obviously fictitious.
  • Follow the conventions in docs/CONVENTIONS.md. When in doubt, make scaffold NAME=roe_xxx and compare.

Before you open a PR

Both CI gates must pass locally:

make lint        # ruff check + ruff format --check
make ci-smoke    # install + test every module against the Docker stack (Odoo 18)

A module is only mergeable if it installs and upgrades cleanly and its tests are green. New behaviour needs a test under the module's tests/ directory.

Module checklist

  • Technical name is snake_case, prefixed roe_.
  • __manifest__.py sets version (18.0.x.y.z), summary, license (LGPL-3), author, depends, and an ordered data list (security before the views that use it).
  • Per-module README.md describing what it does and how to install it.
  • LGPL header on every .py file.
  • At least one test; make ci-smoke is green.

Reporting issues

Open a GitHub issue with the Odoo version, the module, steps to reproduce, and the relevant log output (with any sensitive values redacted).