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: partial
- fast feedback: weak
- task templates: partial
- guardrails: partial
- doc-code alignment: partial
## Top priorities
1. Define repo-standard lint and test wrappers
2. Document service dependencies for integration tests
3. Clarify package ownership boundaries

View File

@@ -0,0 +1,10 @@
# Project Map
## Main structure
- `cmd/` contains runnable binaries
- `internal/` contains non-exported app logic
- `pkg/` is for reusable public packages if present
## Notes
- Check `Makefile` for repo-preferred command wrappers
- Some integration tests may depend on Docker or local services

View File

@@ -0,0 +1,6 @@
# Risk Guardrails
- Treat `cmd/` entrypoints and deployment wiring as high risk
- Do not silently change interfaces consumed by other packages
- Be careful with goroutines, channels, and context cancellation paths
- Do not rewrite broad package layouts for a narrow bugfix

View File

@@ -0,0 +1,14 @@
# Task Templates
## Bugfix
1. Read the affected package and nearby tests
2. Explain root cause briefly
3. Implement the smallest fix in the narrowest package possible
4. Run focused validation, then `go test ./...` if appropriate
5. Report risks, especially around concurrency and I/O
## Refactor
1. Preserve public behavior
2. Avoid package-wide churn unless clearly justified
3. Keep imports, naming, and package boundaries tidy
4. Re-run tests after each meaningful step if the refactor is risky