Fix AGENTS instructions

[chrisaddy]

Summary

• unify mise commands
• improve intro sentence and clarify PR instructions

Testing

• ruff format
• ruff check --output-format=github .
• pytest (fails: command not found)

Summary by CodeRabbit

• Documentation
  • Improved clarity and consistency in instructions.
  • Updated installation command for dependencies.
  • Clarified usage of the Pull Request template.

[coderabbitai]

Walkthrough

The AGENTS.md documentation was updated for improved clarity and consistency. Specific changes include refining wording around code quality and testing, correcting a command for installing dependencies, and making the pull request template instruction more explicit. No code or functional changes were made.

Changes

File(s)	Change Summary
AGENTS.md	Revised wording for clarity, corrected a command, and improved instructions for using the PR template.

Possibly related PRs

• Fix duplicated word in CLAUDE instructions #525: Improves documentation clarity by correcting wording and phrasing, similar to this PR.
• Add Codex instructions #545: Introduced the AGENTS.md file; this PR refines and clarifies its content.

Suggested reviewers

• forstmeier

Poem

In the garden of docs, a rabbit hopped by,
Tidying words with a keen, watchful eye.
Commands now align, instructions are bright,
Clarity blooms in gentle daylight.
With every small fix, the garden grows neat—
A patchwork of guidance, precise and complete! 🐇📄

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d2f6161 and 28bfebc.

📒 Files selected for processing (1)

• AGENTS.md (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Run Python quality checks (ubuntu-latest)

🔇 Additional comments (3)

AGENTS.md (3)

3-3: Clarify 'testing' phrasing for consistency
Updating “code quality and tests” to “code quality and testing” improves readability and aligns the noun forms.

---

5-5: Standardize dependency-install command to mise run
Changing from the outdated mise tasks run python:install to mise run python:install aligns with the other mise run invocations and prevents confusion.

---

14-14: Make Pull Request template instruction more direct
Rewording to “Use the Pull Request template: .github/PULL_REQUEST_TEMPLATE.md.” clearly instructs contributors on which template to apply.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[graphite-app]

Graphite Automations

"Assign author to pull request" took an action on this PR • (05/21/25)

1 assignee was added to this PR based on John Forstmeier's automation.