<!-- Generated by scripts/generate_ai_collab_docs.py. Edit metadata in that script. -->

# Backend Service: feedback

This file adds local guidance for `src/api/flaskr/service/feedback`. Read the
repository root and `src/api/AGENTS.md` first, then use this file for
module-specific ownership and risk points.

## Scope

- This service owns user feedback submission persistence and helper logic for
  collecting qualitative product feedback.

- Primary checked-in entry files today:
  `src/api/flaskr/service/feedback/funs.py`,
  `src/api/flaskr/service/feedback/models.py`

- Keep behavior in this module unless the concern is clearly cross-service and
  shared by multiple backend domains.

- Preferred pytest location: `src/api/tests/service/feedback/` does not exist
  yet; create it when this service gains or changes behavior.

## Do

- Start from the local entry files and preserve how this service already
  structures helpers, models, routes, and DTO-like helpers.

- Keep feedback submission validation close to the persistence helper so
  callers do not invent divergent checks.

- Preserve the link between feedback content, user identity, and any optional
  contact information captured with the report.

- Treat this service as a write-oriented boundary and add explicit query
  helpers before expanding read behavior.

## Avoid

- Do not duplicate feedback persistence logic in route handlers or frontend
  adapters.

- Do not accept new feedback payload fields without updating storage,
  validation, and any downstream notifications together.

- Do not ignore the existing file naming quirk of `funs.py`; follow local
  structure unless you are deliberately refactoring it.

- Avoid scattering service-specific rules upward into root docs when the
  behavior only matters inside this module.

## Commands

- `rg -n "feedback" src/api/flaskr/service src/api/tests` to locate all
  backend call sites and tests before editing.

- `cd src/api && pytest -q` until `src/api/tests/service/feedback/` exists;
  create that directory first when this service gains behavior that needs
  focused regression coverage.

- `cd src/api && FLASK_APP=app.py flask db migrate -m "message"` and review
  the generated revision if schema or indexed business-key changes are made.

- `cd src/api && pytest -q` when a change touches shared DTOs, auth, streaming
  contracts, or other services in addition to this module.

## Tests

- Add or update focused tests around `src/api/tests/service/feedback/` for the
  happy path and the highest-risk validation, permission, or failure case.

- Expand coverage when payload shapes, error codes, or shared helper contracts
  used outside this module change.

- Review persistence-related changes manually for indexing, business-key
  semantics, and migration output whenever models move.

- Document any skipped provider, network, or credential-dependent checks in
  the final task summary.

## Related Skills

- `src/api/SKILL.md`

- `SKILL.md`

- Create a new backend skill under `src/api/skills/<topic>/SKILL.md` when this
  module grows a repeatable multi-step debugging workflow.
