Skip to content

Commit 222ac13

Browse files
feat: add versioned rules for code generation and quality evaluation
- Introduced a new `rules/` directory for managing versioned rules - Added initial draft of code generation rules and quality criteria - Updated documentation to reflect new rule system and usage - Included templates for creating new rule versions
1 parent fcfdab9 commit 222ac13

22 files changed

+8634
-365
lines changed

README.md

Lines changed: 5 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -88,20 +88,16 @@ See [docs/architecture/](docs/architecture/) for details.
8888
pyplots/
8989
├── specs/ # Plot specifications (Markdown)
9090
├── plots/ # Library-specific implementations
91-
│ ├── matplotlib/
92-
│ ├── seaborn/
93-
│ └── plotly/
9491
├── core/ # Shared business logic
9592
├── api/ # FastAPI backend
9693
├── app/ # Next.js frontend
9794
├── automation/ # AI code generation
9895
├── tests/ # Test suite (pytest)
9996
└── docs/ # Documentation
100-
├── architecture/ # System design
101-
├── development.md # Developer guide
102-
└── deployment.md # Cloud deployment
10397
```
10498

99+
**For detailed structure and file organization**, see [Repository Structure](docs/architecture/repository-structure.md)
100+
105101
---
106102

107103
## Documentation
@@ -137,29 +133,19 @@ See [development.md](docs/development.md) for details.
137133
## Development
138134

139135
```bash
140-
# Install dependencies
136+
# Install dependencies (uv is a fast Python package installer)
141137
uv sync --all-extras
142138

143139
# Run tests
144140
uv run pytest
145141

146-
# Format code
147-
uv run ruff format .
148-
149-
# Type check (optional)
150-
uv sync --extra typecheck
151-
uv run mypy .
152-
153142
# Start backend
154143
uv run uvicorn api.main:app --reload
155-
156-
# Start frontend
157-
cd app && npm run dev
158144
```
159145

160-
**Coverage target**: 90%+
146+
**For detailed development setup, testing, and code quality tools**, see [Development Guide](docs/development.md)
161147

162-
**Python versions**: 3.10, 3.11, 3.12, 3.13
148+
**Python versions**: 3.10+ | **Coverage target**: 90%+
163149

164150
---
165151

0 commit comments

Comments
 (0)