Skip to content

docs(#8): add repo-specific conventions to AGENTS.md - #9

Open
fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/8-add-agents-md-conventions
Open

docs(#8): add repo-specific conventions to AGENTS.md#9
fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/8-add-agents-md-conventions

Conversation

@fullsend-ai-coder

Copy link
Copy Markdown
Contributor

Summary

  • Add repo-specific sections to AGENTS.md (sections 6–10) covering architecture decisions, repository structure, testing conventions, data model patterns, and known architecture exceptions
  • Add CLAUDE.md pointing to AGENTS.md as the single source of truth for agent-facing guidance
  • Explicitly document the Python exception for complex collectors, clarify that scripts/ is application code (not CI infrastructure), and list known deviations from the original design.md so review agents do not re-flag them

Context

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 treats scripts/ as CI infrastructure. This AGENTS.md gives agents the repo-specific context they need to avoid false-positive findings.

Test plan

  • Verify AGENTS.md exists at repo root and is tracked by git
  • Verify CLAUDE.md exists at repo root and references AGENTS.md
  • Verify AGENTS.md contains architecture decisions section mentioning Python exception
  • Verify AGENTS.md contains repository structure section clarifying scripts/ role
  • Verify AGENTS.md contains testing conventions section referencing test_*.py pattern
  • Verify AGENTS.md contains data model section (append-only CSV, idempotent writes)
  • Verify AGENTS.md contains known architecture exceptions section
  • Existing Python tests pass (python -m unittest scripts/test_collect_pr_type.py)

Closes #8

Post-script verification

  • Branch is not main/master (agent/8-add-agents-md-conventions)
  • Secret scan passed (gitleaks — 3c3488d88a505beb68f9af8dd21d2500a687988f..HEAD)
  • PR body secret scan passed (gitleaks — no-git)

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>
@fullsend-ai-review

fullsend-ai-review Bot commented Aug 14, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 1:41 PM UTC · Completed 1:56 PM UTC

Commit: 6c6ee94 · View workflow run →

@fullsend-ai-review

Copy link
Copy Markdown

Review

Findings

High

  • [factual-accuracy] AGENTS.md:91 — 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.
    Remediation: Remove the data/ directory entry from the structure diagram and clarify that docs/metrics.csv is the source of truth for SDLC metrics.

  • [factual-accuracy] AGENTS.md:172 — 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".
    Remediation: 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.

Medium

  • [incomplete-architecture-exception-documentation] AGENTS.md:170 — 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.
    Remediation: Expand the Known Architecture Exceptions section to explicitly note the elimination of the data/ directory and the write-once-to-docs pattern.

  • [protected-path] AGENTS.md, CLAUDE.md — This PR modifies files under protected paths (AGENTS.md, CLAUDE.md). The PR links to issue Add AGENTS.md with repo-specific conventions and architecture decisions #8 and explains the rationale. Human approval is always required for protected-path changes, regardless of context.

Low

  • [documentation-completeness] AGENTS.md:100 — 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.
    Remediation: Add the omitted files to the docs/ tree, or expand the existing wildcard comment to cover JS files.

  • [broken-reference] AGENTS.md:46 — Section 4 references CONTRIBUTING.md which does not exist. The "or CLAUDE.md" fallback limits practical impact.
    Remediation: Remove the reference to CONTRIBUTING.md, or list allowed commit types directly in section 4.


Labels: PR adds documentation files (AGENTS.md, CLAUDE.md) and modifies protected paths requiring manual review


Next steps:

  • /fs-fix — agent addresses review findings automatically
  • /fs-fix <your instruction> — agent fixes with your specific guidance
  • Push commits directly — review re-runs automatically on push
  • /fs-fix-stop — disable automatic fix runs for this PR

@fullsend-ai-review fullsend-ai-review Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See the review comment for full details.

Comment thread AGENTS.md
│ ├── 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)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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.

Comment thread AGENTS.md
delivery mix). This is documented in `docs/design.md` under
"Dashboard evolution (2026)."

3. **Multiple CSV files** — the original design specified a single

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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.

Comment thread AGENTS.md
`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)."

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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.

Comment thread AGENTS.md
│ ├── 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

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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.

Comment thread AGENTS.md
<type>(<scope>): <short description>
```

Check `CONTRIBUTING.md` or `CLAUDE.md` for repo-specific allowed types. When

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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.

@fullsend-ai-review fullsend-ai-review Bot added the documentation Improvements or additions to documentation label Aug 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add AGENTS.md with repo-specific conventions and architecture decisions

0 participants