Developer Guide

Developer Guide

Workflow

1. create an issue;
2. create a focused branch;
3. add code and tests;
4. update documentation;
5. run parser/API/frontend checks;
6. open a pull request with evidence;
7. obtain domain review for status or decision changes.

Parser Rule Change Checklist

• synthetic/redacted fixture added;
• raw value preserved;
• provenance retained;
• positive and negative tests added;
• malformed case tested;
• decision impact documented;
• backward compatibility assessed.

API Change Checklist

• Pydantic schema updated;
• OpenAPI output reviewed;
• success and error tests added;
• authentication/authorization impact assessed;
• frontend contract updated;
• migration/versioning documented.

Frontend Change Checklist

• loading, empty, error, and permission states;
• keyboard and screen-reader behavior;
• no sensitive console logging;
• screenshots in pull request;
• component/end-to-end tests;
• API compatibility verified.

Release Checklist

• clean install succeeds;
• tests and build pass;
• configuration files present;
• sample data approved;
• security scan reviewed;
• known limitations updated;
• version/tag and changelog created;
• rollback plan confirmed.