feat: add target repo examples and file layout guidance

This commit is contained in:
2026-04-29 21:55:22 +08:00
parent c507e52dc1
commit 5c80bc12fd
17 changed files with 253 additions and 3 deletions

View File

@@ -0,0 +1,13 @@
# Harness Health
- project map clarity: partial
- validation commands: strong
- fast feedback: partial
- task templates: partial
- guardrails: strong
- doc-code alignment: partial
## Top priorities
1. Add a faster unit-test-only command
2. Document generated-code boundaries more clearly
3. Keep AGENTS.md aligned with actual routes and services

View File

@@ -0,0 +1,13 @@
# Project Map
## Entry points
- `src/index.ts` — app bootstrap
- `src/routes/` — route registration
## Main layers
- routes -> services -> db
- shared utilities live under `src/lib/`
## Notes
- Integration tests may require a local database service
- Some generated types may exist under `src/generated/`; avoid editing them directly unless asked

View File

@@ -0,0 +1,7 @@
# Risk Guardrails
- Do not edit `src/generated/` unless the task is specifically about code generation
- Do not update lockfiles unless dependency changes are required
- Do not disable tests to achieve a passing run
- Treat deployment and CI files as high-risk areas
- Prefer package- or module-scoped validation before full-suite validation

View File

@@ -0,0 +1,20 @@
# Task Templates
## Bugfix
Goal: fix a specific bug with minimal API change.
Required flow:
1. Read relevant implementation and tests
2. Summarize likely root cause briefly
3. Implement the smallest safe fix
4. Run targeted tests, then broader checks if needed
5. Report changed files and residual risks
## Feature
Goal: add a small feature without broad refactors.
Required flow:
1. Inspect related modules and interfaces
2. Preserve public API unless the task says otherwise
3. Add tests for new behavior
4. Run lint, typecheck, and tests