-
-
Notifications
You must be signed in to change notification settings - Fork 609
Add AGENTS.md #4094
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Add AGENTS.md #4094
Conversation
Reviewer's GuideAdds 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
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this 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.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| - Include `RELEASE.md` file describing changes | ||
| - Release types: patch/minor/major | ||
| - Tests required for all code changes with full coverage |
There was a problem hiding this comment.
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? 😊
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: