Skip to content

Conversation

@magicmark
Copy link
Contributor

@magicmark magicmark commented Jan 9, 2026

https://agents.md/ is now a standard supported by most coding agents.

Seems worth adding - e.g. my instance of claude keeps trying to run things with uv, so this would teach it we're using poetry atm.

wdyt?

Summary by Sourcery

Documentation:

  • Add AGENTS.md documenting repository setup, development commands, project structure, and pull request requirements for automated coding agents and contributors.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 9, 2026

Reviewer's Guide

Adds an AGENTS.md file documenting project setup, commands, code style, structure, and PR requirements specifically to guide AI coding agents and contributors.

File-Level Changes

Change Details Files
Document project setup and development workflows for agents and contributors.
  • Describe dependency management and local setup using Poetry and pre-commit hooks
  • List common development commands for tests, type checking, linting, and formatting
  • Specify code style expectations including Ruff configuration, strict mypy typing, decorator-based schema, and async-first design
  • Outline high-level project structure for core library, integrations, and tests
  • Define PR requirements including RELEASE.md usage, release types, and testing expectations
AGENTS.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@magicmark magicmark marked this pull request as ready for review January 9, 2026 20:30
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • Double-check that the listed commands and tools (poetry, mypy strict, ruff, test markers, etc.) exactly match the current project setup and config files so AGENTS.md doesn’t drift from reality.
  • Ensure the PR requirements in AGENTS.md (RELEASE.md requirement, release types, test expectations) are consistent with any existing CONTRIBUTING or release process docs to avoid conflicting guidance.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Double-check that the listed commands and tools (poetry, mypy strict, ruff, test markers, etc.) exactly match the current project setup and config files so AGENTS.md doesn’t drift from reality.
- Ensure the PR requirements in AGENTS.md (RELEASE.md requirement, release types, test expectations) are consistent with any existing CONTRIBUTING or release process docs to avoid conflicting guidance.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment on lines +40 to +42
- Include `RELEASE.md` file describing changes
- Release types: patch/minor/major
- Tests required for all code changes with full coverage
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shall we add an example of release file too? 😊

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.

2 participants