Skip to content

docs: add AGENTS.md and update .gitignore for Python environments#69

Closed
adrianchung wants to merge 1 commit into
gke-labs:mainfrom
adrianchung:agents-md-gke-labs
Closed

docs: add AGENTS.md and update .gitignore for Python environments#69
adrianchung wants to merge 1 commit into
gke-labs:mainfrom
adrianchung:agents-md-gke-labs

Conversation

@adrianchung

@adrianchung adrianchung commented Jun 13, 2026

Copy link
Copy Markdown
Collaborator

Closes #68

Summary

  • Adds AGENTS.md with context for agents and contributors to navigate and run the benchmark:
    • Repository structure overview
    • Step-by-step setup (Python env, OpenTofu install, evaluator invocation)
    • Key environment variables reference table
    • Task YAML format with a minimal example
    • MCP vs no-MCP mode explanation
    • Known gotchas (tofu PATH, Vertex AI fallback, missing MCP binary)
  • Updates .gitignore to exclude Python virtual environment directories (.venv/, venv/)

Test plan

  • Verify an agent starting cold can follow the AGENTS.md instructions to set up and run a task against a local kind cluster
  • Confirm .venv/ is no longer tracked by git after creation

Closes gke-labs#68 — adds AGENTS.md with repo structure overview, benchmark
setup steps, environment variable reference, task format docs, MCP vs
no-MCP guidance, and known gotchas (tofu PATH, Vertex AI fallback,
missing MCP binary). Also adds .venv/ to .gitignore.
@adrianchung

Copy link
Copy Markdown
Collaborator Author

I'm closing this in favor of PR #72

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add an AGENTS.md to make this repository friendly for agents to interact with

1 participant