58 lines
1.6 KiB
Markdown
58 lines
1.6 KiB
Markdown
# [PROJECT NAME] Development Guidelines
|
|
|
|
Auto-generated from all feature plans. Last updated: [DATE]
|
|
|
|
## 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
|
|
|
|
[EXTRACTED FROM ALL PLAN.MD FILES]
|
|
|
|
## Project Structure
|
|
|
|
```text
|
|
[ACTUAL STRUCTURE FROM PLANS]
|
|
```
|
|
|
|
## Commands
|
|
|
|
[ONLY COMMANDS FOR ACTIVE TECHNOLOGIES]
|
|
|
|
## Code Style
|
|
|
|
[LANGUAGE-SPECIFIC, ONLY FOR LANGUAGES IN USE]
|
|
|
|
### 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
|
|
|
|
[LAST 3 FEATURES AND WHAT THEY ADDED]
|
|
|
|
<!-- MANUAL ADDITIONS START -->
|
|
<!-- MANUAL ADDITIONS END -->
|