48 lines
1.4 KiB
Markdown
48 lines
1.4 KiB
Markdown
# Code Review Plan (6-Part Pass + Code-Review Skill)
|
|
|
|
## Goal
|
|
Review the repository in six focused passes. For each pass, run the `code-review` skill on the scoped paths, then capture findings and consolidate issues into a single issues markdown file.
|
|
|
|
## Scope Chunks
|
|
1) **CLI entrypoints**
|
|
- Paths: `cmd/musiclink/`, `cmd/smoketest/`
|
|
|
|
2) **Matrix bot runtime**
|
|
- Paths: `internal/matrixbot/`
|
|
|
|
3) **Message handling & link logic**
|
|
- Paths: `internal/handler/`, `internal/detector/`, `internal/resolver/`, `internal/services/`
|
|
|
|
4) **Config & packaging**
|
|
- Paths: `pkg/config/`, `config.example.toml`, `flake.nix`, `go.mod`, `go.sum`, `vendor/`
|
|
|
|
5) **Docs & design artifacts**
|
|
- Paths: `README.md`, `docs/`
|
|
|
|
6) **Ops/integration references**
|
|
- Paths: `WORKLOG.md`
|
|
|
|
## Process (per chunk)
|
|
1. Run code review:
|
|
```
|
|
/code-review <paths>
|
|
```
|
|
2. Record the review output in a notes file (e.g., `docs/reviews/<chunk>.md`).
|
|
3. Add any confirmed findings to the consolidated issues file:
|
|
- `docs/reviews/issues.md`
|
|
|
|
## Output Files
|
|
- Per-chunk review notes:
|
|
- `docs/reviews/cli-entrypoints.md`
|
|
- `docs/reviews/matrixbot.md`
|
|
- `docs/reviews/message-handling.md`
|
|
- `docs/reviews/config-packaging.md`
|
|
- `docs/reviews/docs.md`
|
|
- `docs/reviews/ops.md`
|
|
|
|
- Consolidated issues:
|
|
- `docs/reviews/issues.md`
|
|
|
|
## Issue Filing
|
|
After reviewing all chunks, summarize issues and ask for approval before filing.
|