missing-readme (ODOO016)

Preview (since 0.16.2.2) · Related issues · View source

Derived from the odoo linter.

This rule is unstable and in preview. The --preview flag is required for use.

What it does

Checks that an Odoo module has a README.rst, README.md, or README.txt file next to its __manifest__.py.

Why is this bad?

The README is what's shown on the module's Apps page and is the primary source of documentation for the module.