Skip to content

docs(#8): add testing and type annotation conventions - #9

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

fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/8-add-testing-type-conventions

Conversation

@fullsend-ai-coder

Copy link
Copy Markdown
Contributor

Summary

  • Add three new convention bullets to the Conventions section of AGENTS.md:
    • All functions must have return type annotations (including -> None)
    • Test functions follow test_<function_name>_<behavior> naming pattern
    • Test run command: uv run pytest tests/ -v
  • Codifies patterns established in PR feat(#4): greet user by name instead of "World" #7 to prevent review-fix cycles for naming inconsistency and missing annotation findings

Testing

  • Verified AGENTS.md contains all three new convention bullets in the Conventions section
  • Verified the existing four convention bullets are preserved unchanged
  • Ran uv run pytest tests/ -v — all 4 tests pass
  • Documentation-only change; no functional code modified

Closes #8

Post-script verification

  • Branch is not main/master (agent/8-add-testing-type-conventions)
  • Secret scan passed (gitleaks — e9bff5bd6e49cc49d4dde6cd09206e40532e9aea..HEAD)
  • PR body secret scan passed (gitleaks — no-git)

Add three convention bullets to the Conventions section of
AGENTS.md to guide code agents on consistent practices:

- Return type annotations required on all functions,
  including -> None for void functions
- Test naming pattern: test_<function_name>_<behavior>
- Test run command: uv run pytest tests/ -v

These conventions codify patterns established in PR #7 and
prevent review-fix cycles for naming inconsistency and
missing annotation findings.

Closes #8
@fullsend-ai-coder fullsend-ai-coder Bot added the ready-for-review Triggers review agent dispatch label Sep 9, 2026
@fullsend-ai-review

fullsend-ai-review Bot commented Sep 9, 2026 •

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 9:20 PM UTC · Completed 9:31 PM UTC

Commit: 91d4d5e · View workflow run →

Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $2.56

@fullsend-ai-review fullsend-ai-review Bot added the risk/low PR risk: low label Sep 9, 2026
@fullsend-ai-review

Copy link
Copy Markdown

Risk Assessment: low (1/5)

Details

Minimal-risk documentation-only PR adding 3 lines to AGENTS.md by a bot, with exact issue scope alignment and no security, CI, or dependency changes; the sole elevated signal is the protected-path flag on AGENTS.md.

@fullsend-ai-review

Copy link
Copy Markdown

Review

Findings

Medium

@fullsend-ai-review fullsend-ai-review Bot added the requires-manual-review Review requires human judgment label Sep 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-for-review Triggers review agent dispatch requires-manual-review Review requires human judgment risk/low PR risk: low

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add testing and type annotation conventions to AGENTS.md

0 participants