809 B
809 B
Development Standards
(To be defined. This document will outline coding conventions, patterns, and best practices for the project.)
General Principles
- Clarity and Readability: Code should be easy to understand and maintain.
- Modularity: Design components with clear responsibilities and interfaces.
- Testability: Write code that is easily testable.
Python (FastAPI Backend)
- Follow PEP 8 style guidelines.
- Use type hints.
- Structure API endpoints logically.
JavaScript (Vanilla JS Frontend)
- Follow modern JavaScript best practices (ES6+).
- Organize code into modules.
- Prioritize performance and responsiveness.
Commit Messages
- Follow conventional commit message format (e.g.,
feat: add new TTS feature
,fix: resolve audio playback bug
).