Skip to content

docs: add AI agent guide - #78

Merged
marcieltorres merged 1 commit into
marcieltorres:mainfrom
pollychen-lab:docs/issue-71-agents-guide
Jul 13, 2026
Merged

docs: add AI agent guide#78
marcieltorres merged 1 commit into
marcieltorres:mainfrom
pollychen-lab:docs/issue-71-agents-guide

Conversation

@pollychen-lab

Copy link
Copy Markdown
Contributor

Summary

  • Add a root AGENTS.md for AI coding agents working in this Python boilerplate.
  • Document the project layout, Makefile workflows, Ruff/pytest expectations, PR flow, and security guardrails.
  • Point agents to existing canonical files instead of duplicating all setup details.

Closes #71

Testing

  • git diff --check
  • uvx poetry run ruff check .
  • make local/install
  • make local/lint
  • make local/tests

Note: this environment does not have Poetry installed globally, so I used a temporary poetry shim that delegates to uvx poetry for the Makefile validation. Generated local artifacts (.env, poetry.lock, coverage.xml, htmlcov/) were removed and are not part of this PR.

@marcieltorres
marcieltorres merged commit c6ed5ed into marcieltorres:main Jul 13, 2026
1 check passed
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 AGENTS.md file for AI coding agent guidance

2 participants