BITFSAE Project Standards

Goal

Make the project understandable, modifiable, testable, and transferable without forcing a uniform layout. Preserve correct project-specific choices; enforce shared minimum standards only where they improve safety, consistency, or handover.

Workflow

1. Read repository instructions and inspect the current tree, build system, source, generated files, tests, documents, schemas, and version history.
2. Identify authoritative sources for each fact. Current behavior → implementation code and generator configuration; electrical facts → hardware design files; shared interfaces → approved network/database files.
3. Classify the project and its maturity. Read project-adaptation.md for non-typical or constrained projects, documentation-system.md before reorganizing documents, and embedded-interfaces.md for MCU, CAN, hardware, generated code, or real-time behavior.
4. Build a short inventory of public interfaces, frequently changed settings, major modules, failure behavior, build paths, and known unverified assumptions.
5. Compare documentation against implementation. Correct stale claims, ambiguous units, missing ranges, wrong byte order, copied project facts, and duplicated specifications.
6. Add or reorganize only the documents the project needs. Read documentation-system.md first.
7. Validate links, examples, schemas, builds, and tests in proportion to the change. Record user-visible or maintenance-relevant changes in CHANGELOG.md.

Do not change intended behavior during a documentation-only task. If documentation reveals a likely code defect, report it or fix it only when authorized.

Minimum Standards