Add comprehensive specifications and planning documents for Reference Board Viewer application. Include detailed data model, API contracts, quickstart guide, and task breakdown for implementation. Ensure all artifacts are aligned with project objectives and constitutional principles.

This commit is contained in:
Danilo Reyes
2025-11-01 22:19:39 -06:00
parent d5a1819e2f
commit 58f463867e
8 changed files with 4371 additions and 475 deletions

View File

@@ -0,0 +1,58 @@
# webref Development Guidelines
Auto-generated from all feature plans. Last updated: 2025-11-01
## Constitutional Principles
This project follows a formal constitution (`.specify/memory/constitution.md`). All development work MUST align with these principles:
1. **Code Quality & Maintainability** - Clear, maintainable code with proper typing
2. **Testing Discipline** - ≥80% coverage, automated testing required
3. **User Experience Consistency** - Intuitive, accessible interfaces
4. **Performance & Efficiency** - Performance-first design with bounded resources
Reference the full constitution for detailed requirements and enforcement mechanisms.
## Active Technologies
- (001-reference-board-viewer)
## Project Structure
```text
src/
tests/
```
## Commands
# Add commands for
## Code Style
: Follow standard conventions
### Constitutional Requirements
All code MUST meet these standards (per Principle 1):
- Linter passing (zero errors/warnings)
- Type hints on all public APIs
- Clear single responsibilities (SRP)
- Explicit constants (no magic numbers)
- Comments explaining "why" not "what"
## Testing Standards
Per Constitutional Principle 2:
- Minimum 80% test coverage required
- Unit tests for all public functions
- Integration tests for component interactions
- Edge cases and error paths explicitly tested
- Tests are deterministic, isolated, and fast (<1s unit, <10s integration)
## Recent Changes
- 001-reference-board-viewer: Added
<!-- MANUAL ADDITIONS START -->
<!-- MANUAL ADDITIONS END -->