Skip to content

docs: expand AGENTS.md with enforced checks and review conventions - #734

Draft
jariy17 wants to merge 1 commit into
mainfrom
docs/agent-guidance
Draft

jariy17 wants to merge 1 commit into
mainfrom
docs/agent-guidance

Conversation

@jariy17

@jariy17 jariy17 commented Nov 4, 2026

Copy link
Copy Markdown
Contributor

Problem

AGENTS.md only linked to two other files, so agents working here had no record of what CI enforces or of the conventions reviewers keep asking for. TESTING.md described the integration CI as three groups when it runs nine, and CONTRIBUTING.md linked to a documentation.md issue template that doesn't exist.

Change

  • AGENTS.md now covers:
    • commands, and what pre-commit, pre-push and CI actually check (Python 3.10–3.13, fail_under = 90, ruff rules, the griffe breaking-change check, the PR title format);
    • layout and the shared _utils helpers;
    • conventions drawn from review comments on merged PRs: keyword-only new parameters, the boto3 allowlist passthrough, optional extras and uv.lock, partition-safe endpoints and the endpoint-override pattern, catching errors by type, async and locking pitfalls, no user content in spans or logs, imports at the top, and testing pitfalls.
  • AGENTS.md notes that mypy is configured but not run in CI.
  • TESTING.md: the CI section now matches integration-testing.yml; added integration test conventions (region default, waiting with wait_until or the *_and_wait helpers, asserting updates, skipping before creating resources).
  • CONTRIBUTING.md: fixed the documentation-issue link and pointed to AGENTS.md.

Verification

Checked each statement against pyproject.toml, .pre-commit-config.yaml, the workflows, scripts/bump_version.py and src/.

@jariy17
jariy17 deployed to auto-approve November 4, 2026 19:40 — with GitHub Actions Active
@jariy17
jariy17 deployed to auto-approve November 4, 2026 19:40 — with GitHub Actions Active
@jariy17
jariy17 deployed to auto-approve November 4, 2026 19:40 — with GitHub Actions Active
@jariy17
jariy17 deployed to auto-approve November 4, 2026 19:40 — with GitHub Actions Active
@jariy17
jariy17 deployed to auto-approve November 4, 2026 19:40 — with GitHub Actions Active
@jariy17
jariy17 deployed to auto-approve November 4, 2026 19:40 — with GitHub Actions Active
@jariy17
jariy17 deployed to auto-approve November 4, 2026 19:40 — with GitHub Actions Active
@github-actions github-actions Bot added the size/m PR size: M label Nov 4, 2026
@agentcore-devx-automation agentcore-devx-automation Bot added the claude-security-reviewing Claude Code /security-review in progress label Nov 4, 2026
@agentcore-devx-automation

Copy link
Copy Markdown
Contributor

Claude Security Review: no high-confidence findings. (run)

@agentcore-devx-automation agentcore-devx-automation Bot removed the claude-security-reviewing Claude Code /security-review in progress label Nov 4, 2026

This branch was successfully deployed

1 active deployment
auto-approve — d014f122 Deployed Nov 4, 2026 by jariy17 via Test (services) #1692
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/m PR size: M

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant