pedwfrontend/memory-bank/README.md

Memory Bank Operating Protocol

Purpose

Capture durable engineering knowledge for PEDW FrontEnd so AI agents and humans make consistent, safe decisions over time.

When to Update

Update memory-bank entries when any of the following occur:

1. A non-trivial architectural or implementation decision is made.
2. A recurring pattern is introduced or standardized.
3. A pitfall/incident/root cause is discovered.
4. A release introduces meaningful behavior/risk changes.
5. Open questions block safe delivery.

Who Updates

• AI agent: must add or amend entries for non-trivial changes completed during a task.
• Human engineer/reviewer: validates or amends entries during PR review.
• Tech lead/owner: resolves open questions and marks decisions as accepted/superseded.

Required Metadata (for every new entry)

• date: YYYY-MM-DD
• author: agent name or person
• scope: files/routes/features affected
• type: decision | pattern | pitfall | change | question | glossary
• rationale: why this matters
• impact: user/system/security/i18n/a11y implications
• status: proposed | accepted | superseded | open | resolved

Entry Quality Rules

• Keep entries concise and specific to this repository.
• Link to concrete files/paths where possible.
• Do not include secrets, tokens, personal data, or sensitive payload examples.
• If uncertain, record assumptions explicitly and add to open-questions.md.