This guide establishes the coding conventions for the shipyard project.
| Topic | Key Point |
|---|---|
| Functional Programming | Use flow and pipe to compose transformations; avoid intermediary variables |
| Naming Conventions | Use descriptive, full-word names that make code self-documenting |
| Documentation Through Code | Avoid comments; extract complex code to well-named functions instead |
| Web Components and Native APIs | Use custom elements instead of React, Vue, jQuery for interactivity |
| Integration Testing | Every feature requires meaningful tests using demo apps as fixtures |
| Effect | Use Effect for functional pipes, compositions, and option handling |
| TypeScript Standards | Write all code in strict TypeScript; types are living documentation |
| Astro Content Loaders | Use Astro content collections instead of direct file system access |