1.5 KiB
1.5 KiB
paths
| paths | |
|---|---|
|
Prototype Code Standards (Relaxed)
Prototypes are throwaway code for validating ideas. Standards are intentionally relaxed to maximize iteration speed. The goal is learning, not production quality.
What's Allowed in Prototypes
- Hardcoded values (no need for data-driven config)
- Minimal or no doc comments
- Simple architecture (no dependency injection required)
- Singletons and global state
- Copy-pasted code (no need for abstraction)
- Debug output left in place
- Placeholder art and audio
- Quick-and-dirty solutions
What's Still Required
- Each prototype lives in its own subdirectory:
prototypes/[name]/ - Every prototype MUST have a
README.mdwith:- What hypothesis is being tested
- How to run the prototype
- Current status (in-progress / concluded)
- Findings (updated when prototype concludes)
- No production code may reference or import from
prototypes/ - Prototypes must not modify files outside
prototypes/ - Prototypes must not be deployed or shipped
When a Prototype Succeeds
If a prototype validates a concept and the feature moves to production:
- The prototype code is NOT migrated directly — it is rewritten to production standards
- The prototype
README.mdfindings inform the production design document - The prototype directory is preserved for reference but never extended
Cleanup
Concluded prototypes should be archived or deleted after findings are captured. Never let prototype code grow into production code through incremental "cleanup."