Improve agentready score for fullsend onboarding by yashvardhannanavati · Pull Request #9 · release-engineering/iib-tekton-utils

yashvardhannanavati · 2026-05-31T04:03:02Z

Adds a minimal ~60 line AGENTS.md file documenting project structure, key files, commands, and architecture for AI coding assistants. Includes test structure and pytest commands.

CLAUDE.md is a symlink to AGENTS.md.

qodo-for-release-engineering · 2026-05-31T04:03:15Z

Review Summary by Qodo

Add AGENTS.md and CLAUDE.md for AI agent onboarding

📝 Documentation

Walkthroughs

Description

• Add AGENTS.md documentation for AI agent onboarding
• Document project structure, key files, and commands
• Include test structure and pytest command examples
• Create CLAUDE.md symlink to AGENTS.md

Diagram

flowchart LR
  A["Documentation Need"] -->|"Create onboarding guide"| B["AGENTS.md"]
  B -->|"66 lines of project info"| C["Project Structure"]
  B -->|"Tech Stack & Key Files"| D["Developer Reference"]
  B -->|"Test Commands & Architecture"| E["Implementation Details"]
  F["CLAUDE.md"] -->|"symlink to"| B

File Changes

1. AGENTS.md 📝 Documentation +66/-0

AI agent onboarding documentation with project details

• Comprehensive 66-line documentation for AI agent onboarding
• Documents project structure, tech stack, and key files
• Includes directory structure and command examples for testing and building
• Provides architecture notes with specific line references and test coverage details

AGENTS.md

2. CLAUDE.md 📝 Documentation +1/-0

Symlink to AGENTS.md documentation

• Single-line symlink file pointing to AGENTS.md
• Provides alternative entry point for Claude AI assistant

CLAUDE.md

qodo-for-release-engineering · 2026-05-31T04:03:16Z

Code Review by Qodo

🐞 Bugs (3) 📘 Rule violations (0)

1. CLAUDE.md not readable 🐞 Bug ≡ Correctness ⭐ New

Description

CLAUDE.md is added with only the single-line payload AGENTS.md, so any consumer that reads the
file contents without resolving symlinks/pointers will not see the onboarding instructions. This
defeats the purpose of having CLAUDE.md as an entry point for agent onboarding.

Code

CLAUDE.md[1]

Evidence

The PR adds CLAUDE.md with only the text AGENTS.md, which is not the actual onboarding content
and will be all that non-symlink-resolving readers see.

CLAUDE.md[1-1]
AGENTS.md[1-66]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
`CLAUDE.md` currently contains only `AGENTS.md` (a pointer/symlink payload style content). Tools that don’t resolve symlinks/pointers will not receive the intended onboarding instructions.

### Issue Context
This PR aims to onboard AI agents via `CLAUDE.md`/`AGENTS.md`. To be robust across different file-readers, `CLAUDE.md` should contain actual markdown content (or at least a clear markdown link) rather than relying on symlink semantics.

### Fix Focus Areas
- CLAUDE.md[1-1]

### Suggested fix
Either:
1) Replace `CLAUDE.md` with a small markdown file that links to `AGENTS.md` (and optionally duplicates the critical “Commands” section), or
2) Vendor/copy the full content of `AGENTS.md` into `CLAUDE.md`.
Also ensure the file ends with a newline.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

2. Stale line-number references 🐞 Bug ⚙ Maintainability ⭐ New

Description

AGENTS.md hardcodes specific line numbers for symbols in multi-arch-builder.py (e.g., :201,
:144, :271, :365), which will become incorrect as the file changes and misdirect
onboarding/debugging. This makes the onboarding guide degrade quickly over time.

Code

AGENTS.md[R56-61]

Evidence
AGENTS.md explicitly embeds line numbers for code symbols; those numbers are inherently unstable as
the referenced file changes.
AGENTS.md[54-61]
task/iib-image-builder-oci-ta/multi-arch-builder.py[144-205]
task/iib-image-builder-oci-ta/multi-arch-builder.py[271-371]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
`AGENTS.md` references code locations using exact line numbers (e.g., `multi-arch-builder.py:201`). These are brittle and will drift with routine edits, causing the onboarding documentation to point to the wrong place.

### Issue Context
The intent is to help humans/agents quickly locate important code. Line numbers are not stable identifiers in git; symbol names and search hints are stable.

### Fix Focus Areas
- AGENTS.md[56-61]

### Suggested fix
Replace line-number references with stable identifiers, for example:
- “`MultiArchBuilder` class in `task/iib-image-builder-oci-ta/multi-arch-builder.py`”
- “`generate_cache_locally()` function in `task/iib-image-builder-oci-ta/multi-arch-builder.py`”
- “Retry logic via `@retry(...)` decorators on `_build_image` and `_create_and_push_manifest_list`”
Optionally add a short ‘search for’ hint (e.g., `class MultiArchBuilder`, `def generate_cache_locally`).

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

3. Buildah command inconsistency 🐞 Bug ⚙ Maintainability

Description

AGENTS.md documents building the container image using buildah bud ... -t iib-build-task ., while
README.md documents buildah build ... -t iib-build-task:latest .; although both subcommands work,
the mismatch (and tag difference) can cause copy/paste confusion for contributors.

Code

AGENTS.md[R50-52]

Evidence

The new onboarding doc uses buildah bud and a different tag than the existing README build
instructions, creating inconsistent guidance.

AGENTS.md[35-52]
README.md[155-161]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
`AGENTS.md` and `README.md` document different buildah commands/tags for building the same container image. Even though `buildah bud` and `buildah build` are typically equivalent, the mismatch (including the image tag) can confuse users and lead to inconsistent local workflows.

### Issue Context
- `AGENTS.md` is new onboarding documentation.
- `README.md` already documents build instructions.

### Fix Focus Areas
- AGENTS.md[50-52]
- README.md[155-161]

### Suggested fix
Update `AGENTS.md` to match the `README.md` command (or update both to a single preferred form), including the image tag (e.g., `iib-build-task:latest`). If you want to keep both forms, add a brief note that `bud` is an alias for `build` and ensure the tag is consistent.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

Previous review results

Review updated until commit d62144f

Results up to commit ae2017f

🐞 Bugs (1) 📘 Rule violations (0) 📎 Requirement gaps (0)

1. Buildah command inconsistency 🐞 Bug ⚙ Maintainability

Description

AGENTS.md documents building the container image using buildah bud ... -t iib-build-task ., while
README.md documents buildah build ... -t iib-build-task:latest .; although both subcommands work,
the mismatch (and tag difference) can cause copy/paste confusion for contributors.

Code

AGENTS.md[R50-52]

Evidence

The new onboarding doc uses buildah bud and a different tag than the existing README build
instructions, creating inconsistent guidance.

AGENTS.md[35-52]
README.md[155-161]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
`AGENTS.md` and `README.md` document different buildah commands/tags for building the same container image. Even though `buildah bud` and `buildah build` are typically equivalent, the mismatch (including the image tag) can confuse users and lead to inconsistent local workflows.

### Issue Context
- `AGENTS.md` is new onboarding documentation.
- `README.md` already documents build instructions.

### Fix Focus Areas
- AGENTS.md[50-52]
- README.md[155-161]

### Suggested fix
Update `AGENTS.md` to match the `README.md` command (or update both to a single preferred form), including the image tag (e.g., `iib-build-task:latest`). If you want to keep both forms, add a brief note that `bud` is an alias for `build` and ensure the tag is consistent.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

Adds a minimal ~60 line AGENTS.md file documenting project structure, key files, commands, and architecture for AI coding assistants. Includes test structure and pytest commands. CLAUDE.md is a symlink to AGENTS.md. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

yashvardhannanavati · 2026-05-31T04:22:05Z

/agentic_review

qodo-for-release-engineering · 2026-05-31T04:22:13Z

Code review by qodo was updated up to the latest commit d62144f

Adds standard Python .gitignore patterns for: - __pycache__ and bytecode files - Virtual environments - Testing artifacts - IDE files - AgentReady reports Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

Adds GitHub templates for better issue/PR workflows: - PULL_REQUEST_TEMPLATE.md with summary, testing checklist - bug_report.md issue template - feature_request.md issue template Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

Configures Dependabot for automated security updates: - Weekly pip dependency updates - Weekly GitHub Actions updates Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

Configures pre-commit hooks for code quality: - trailing-whitespace, end-of-file-fixer - check-yaml, check-added-large-files - ruff linter and formatter - conventional-pre-commit for commit message validation Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

Adds pinned dependency versions for reproducible builds: - tenacity==8.2.3 (runtime) - pytest==8.2.1, pytest-mock==3.14.0, PyYAML==6.0.1 (test) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

Updates AGENTS.md with: - Single-file lint command (ruff check) - Single-file type check command (mypy) - Pre-commit setup command - Pattern References section for common changes Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

ambient-code Bot force-pushed the update-agents-md-with-tests branch from ae2017f to d62144f Compare May 31, 2026 04:19

Ambient Code Bot and others added 6 commits May 31, 2026 04:24

chore: add .gitignore with Python patterns

ab807e6

Adds standard Python .gitignore patterns for: - __pycache__ and bytecode files - Virtual environments - Testing artifacts - IDE files - AgentReady reports Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

chore: add PR and issue templates

489d4da

Adds GitHub templates for better issue/PR workflows: - PULL_REQUEST_TEMPLATE.md with summary, testing checklist - bug_report.md issue template - feature_request.md issue template Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

chore: add Dependabot configuration

12bbf75

Configures Dependabot for automated security updates: - Weekly pip dependency updates - Weekly GitHub Actions updates Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

chore: add requirements.txt with pinned versions

63825ae

Adds pinned dependency versions for reproducible builds: - tenacity==8.2.3 (runtime) - pytest==8.2.1, pytest-mock==3.14.0, PyYAML==6.0.1 (test) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

yashvardhannanavati changed the title ~~Add AGENTS.md and CLAUDE.md for AI agent onboarding~~ Improve agentready score for fullsend onboarding May 31, 2026

yashvardhannanavati requested a review from lipoja June 1, 2026 21:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve agentready score for fullsend onboarding#9

Improve agentready score for fullsend onboarding#9
yashvardhannanavati wants to merge 7 commits into
release-engineering:mainfrom
yashvardhannanavati:update-agents-md-with-tests

yashvardhannanavati commented May 31, 2026

Uh oh!

qodo-for-release-engineering Bot commented May 31, 2026

Uh oh!

qodo-for-release-engineering Bot commented May 31, 2026 •

edited

Loading

Uh oh!

yashvardhannanavati commented May 31, 2026

Uh oh!

qodo-for-release-engineering Bot commented May 31, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

yashvardhannanavati commented May 31, 2026

Uh oh!

qodo-for-release-engineering Bot commented May 31, 2026

Review Summary by Qodo

Walkthroughs

File Changes

Uh oh!

qodo-for-release-engineering Bot commented May 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review by Qodo

Previous review results

Uh oh!

yashvardhannanavati commented May 31, 2026

Uh oh!

qodo-for-release-engineering Bot commented May 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

qodo-for-release-engineering Bot commented May 31, 2026 •

edited

Loading

qodo-for-release-engineering Bot commented May 31, 2026 •

edited

Loading