# <Module / Feature name>

- **Module:** `<Vendor_Module>`
- **Branch / MR:** <branch or MR link>
- **Date:** <YYYY-MM-DD>
- **Author:** <name>

## Purpose

What this module does and why it exists — the problem it solves for the business.

## How it works

The main flow, key classes/components, and the data model. Include an admin/menu
path if it has UI.

## Configuration

| Setting | Location | Values | Default |
|---------|----------|--------|---------|
| … | … | … | … |

## Data model

Tables, columns, and relationships (or "None").

## Integration points

Other modules, APIs, events/observers, or frontend components it depends on or is
consumed by.

## Testing

- [ ] `php bin/magento setup:di:compile`
- [ ] `php bin/magento setup:upgrade`
- [ ] Angular build (`ng build`) — if frontend changed
- [ ] Manual verification of the module's flows

## Security / operational notes

ACL resources, permissions, data migration, seed data, and any operational caveats.