docs(#8): add repo-specific conventions to AGENTS.md - #9
docs(#8): add repo-specific conventions to AGENTS.md#9fullsend-ai-coder[bot] wants to merge 1 commit into
Conversation
Add sections 6–10 to AGENTS.md covering architecture decisions, repository structure, testing conventions, data model patterns, and known architecture exceptions. These sections give agents repo-specific context so they do not re-flag intentional deviations from the original design.md Key Decisions (e.g., Python for the PR-type collector, multiple HTML pages, multiple CSV files). The repository structure section clarifies that scripts/ contains application code, not CI infrastructure. Also add CLAUDE.md pointing to AGENTS.md as the single source of truth for agent-facing guidance. Closes #8 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
🤖 Finished Review · ✅ Success · Started 1:41 PM UTC · Completed 1:56 PM UTC Commit: |
ReviewFindingsHigh
Medium
Low
Labels: PR adds documentation files (AGENTS.md, CLAUDE.md) and modifies protected paths requiring manual review Next steps:
|
| │ ├── collect-pr-type.sh # PR type collector (shell wrapper) | ||
| │ ├── collect-pr-type.py # PR type collector (Python implementation) | ||
| │ ├── backfill*.sh # One-time historical backfill scripts | ||
| │ ├── lib.sh # Shared shell helpers (CSV I/O, API wrappers) |
There was a problem hiding this comment.
[high] factual-accuracy
Repository structure diagram shows data/metrics.csv as the source of truth, but the data/ directory does not exist. The actual path is docs/metrics.csv (defined in scripts/lib.sh:5). An agent following this documentation would look for a directory and file that do not exist.
Suggested fix: Remove the data/ directory entry from the structure diagram and clarify that docs/metrics.csv is the source of truth for SDLC metrics.
| delivery mix). This is documented in `docs/design.md` under | ||
| "Dashboard evolution (2026)." | ||
|
|
||
| 3. **Multiple CSV files** — the original design specified a single |
There was a problem hiding this comment.
[high] factual-accuracy
Section 10, item 3 states: 'The original data/metrics.csv still exists as the source of truth for SDLC metrics.' This is factually incorrect — data/metrics.csv does not exist. The workflow commits only docs/, and scripts/lib.sh:5 defines DATA_FILE="docs/metrics.csv".
Suggested fix: Rewrite item 3 to clarify that the original design specified data/metrics.csv but the implemented architecture writes directly to docs/metrics.csv. Remove the false claim that data/metrics.csv still exists.
| `index.html`. The dashboard now has `index.html` (overview), | ||
| `details.html` (drill-down), and `delivered-pr-types.html` (PR | ||
| delivery mix). This is documented in `docs/design.md` under | ||
| "Dashboard evolution (2026)." |
There was a problem hiding this comment.
[medium] incomplete-architecture-exception-documentation
Section 10 documents 'Multiple CSV files' as an architecture exception but does not document the more significant deviation: elimination of the data/ directory. The original design specified data/metrics.csv as the source file with a copy step to docs/. The implemented pattern writes directly to docs/ with no separate data layer.
Suggested fix: Expand the Known Architecture Exceptions section to explicitly note the elimination of the data/ directory and the write-once-to-docs pattern.
| │ ├── details.html # Per-day drill-down view | ||
| │ ├── delivered-pr-types.html # PR delivery-mix dashboard tab | ||
| │ ├── dashboard.js # Shared chart/table helpers | ||
| │ ├── *.csv # Data files served by GitHub Pages |
There was a problem hiding this comment.
[low] documentation-completeness
The docs/ listing in Section 7 includes dashboard.js but omits details.js and delivered-pr-types.js (page-specific JS for the listed HTML pages), plus design.md, rework-config.json, and holidays.yaml.
Suggested fix: Add the omitted files to the docs/ tree, or expand the existing wildcard comment to cover JS files.
| <type>(<scope>): <short description> | ||
| ``` | ||
|
|
||
| Check `CONTRIBUTING.md` or `CLAUDE.md` for repo-specific allowed types. When |
There was a problem hiding this comment.
[low] broken-reference
Section 4 references CONTRIBUTING.md which does not exist. The 'or CLAUDE.md' fallback limits practical impact.
Suggested fix: Remove the reference to CONTRIBUTING.md, or list allowed commit types directly in section 4.
Summary
scripts/is application code (not CI infrastructure), and list known deviations from the original design.md so review agents do not re-flag themContext
PR #7 was flagged 3 times by the review agent for an architecture deviation (Python usage) that is intentional and documented in design.md. The review agent also flagged
scripts/modifications as protected-path changes because the default config treatsscripts/as CI infrastructure. This AGENTS.md gives agents the repo-specific context they need to avoid false-positive findings.Test plan
scripts/roletest_*.pypatternpython -m unittest scripts/test_collect_pr_type.py)Closes #8
Post-script verification
agent/8-add-agents-md-conventions)3c3488d88a505beb68f9af8dd21d2500a687988f..HEAD)