Skip to content

Refresh AGENTS.md against current code and CI - #57

Merged
glenn-jocher merged 1 commit into
mainfrom
agents-md-review
Sep 27, 2026
Merged

glenn-jocher merged 1 commit into
mainfrom
agents-md-review

Conversation

@glenn-jocher

@glenn-jocher glenn-jocher commented Sep 27, 2026 •

Copy link
Copy Markdown
Member

Refresh AGENTS.md against current code and CI (docs only, net -8 lines). No code bugs found during the review.

  • Wrong: "Google-style docstrings, modern type hints, and a 120-character Python line length are formatted by Ruff" — Ruff doesn't produce docstring style; the generator emits it (lib/generators/python.ts) and format.yml sets python_docstrings: false. Removed; the Python output conventions section already covers docstrings.
  • Contradiction: "Bun, Node, uv, and Python are required" vs README's "Install Bun and uv". CI never sets up Node, and Bun provides node for package scripts. Changed to Bun, uv, and Python.
  • Missing checks: CI runs python -m compileall -q generated/python/src and the pinned uvx ruff@0.16.2 check generated/python, but the command block left them out. Added both, and removed the prose that duplicated them.
  • Where to look: added lib/config.ts (config schema, required keys, OPENAPI_CONFIG, relative-path resolution) and scripts/headers.ts.
  • Bloat: removed the duplicate "Generated output must be deterministic" line (Pitfalls covers it) and the format.yml Prettier/git pull --rebase line (PR Workflow steps 1 and 4 cover it). Condensed the Platform SDK version section to its binding rules plus a pointer to ultralytics/sdk's AGENTS.md, which already holds the full procedure word for word.

Validated: bun run generate, bun run lint, bun run test (20 pass), compileall, ruff@0.16.2 check, and prettier@3.8.5 --print-width 120 --check AGENTS.md.

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Updated AGENTS.md to match the repository’s current configuration, tooling requirements, and CI checks.

📊 Key Changes

  • Added generated-Python compile and pinned Ruff check commands to the validation instructions, and clarified the required tools are Bun, uv, and Python.
  • Updated “Where to look” with the configuration schema and header-generation components.
  • Condensed the Platform SDK version guidance and removed duplicated or inaccurate formatting and workflow notes.

🎯 Purpose & Impact

  • Keeps contributor guidance aligned with the documented CI workflow; no runtime or user-facing behavior changed.

Remove the claim that Ruff formats Google-style docstrings (the generator emits them; format.yml sets python_docstrings: false), drop duplicated determinism and pull --rebase lines, condense the Platform SDK version policy that ultralytics/sdk AGENTS.md owns in full, list CI's pinned Ruff and compileall checks, and point to lib/config.ts and scripts/headers.ts.
@UltralyticsAssistant UltralyticsAssistant added the documentation Improvements or additions to documentation label Sep 27, 2026
@UltralyticsAssistant

Copy link
Copy Markdown
Member

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/openapi 🚀 PR! This automated message confirms your contribution was received, and an Ultralytics engineer will assist with the review. To ensure a seamless integration of your work, please review the following checklist:

  • ✅ Define a Purpose: Clearly explain the purpose of your fix or feature in your PR description, and link to any relevant issues. Ensure your commit messages are clear, concise, and adhere to the project's conventions.
  • ✅ Synchronize with Source: Confirm your PR is synchronized with the ultralytics/openapi main branch. If it's behind, update it by clicking the 'Update branch' button or by running git pull and git merge main locally.
  • ✅ Ensure CI Checks Pass: Verify all Ultralytics Continuous Integration (CI) checks are passing. If any checks fail, please address the issues.
  • ✅ Update Documentation: Update the relevant documentation for any new or modified features.
  • ✅ Add Tests: If applicable, include or update tests to cover your changes, and confirm that all tests are passing.
  • ✅ Sign the CLA: Please ensure you have signed our Contributor License Agreement if this is your first Ultralytics PR by writing "I have read the CLA Document and I sign the CLA" in a new message.
  • ✅ Minimize Changes: Limit your changes to the minimum necessary for your bug fix or feature addition. "It is not daily increase but daily decrease, hack away the unessential. The closer to the source, the less wastage there is." — Bruce Lee

For more guidance, please refer to our Contributing Guide. Don't hesitate to leave a comment if you have any questions. Thank you for contributing to Ultralytics! 🚀

@UltralyticsAssistant UltralyticsAssistant left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🔍 PR Review

Made with ❤️ by Ultralytics Actions

LGTM. Reviewed the AGENTS.md updates against the README, CI workflow, package scripts, and referenced repository locations. The guidance aligns with the current repository; no actionable issues found.

@glenn-jocher
glenn-jocher merged commit f14fac7 into main Sep 27, 2026
7 checks passed
@glenn-jocher
glenn-jocher deleted the agents-md-review branch September 27, 2026 21:03
@UltralyticsAssistant

Copy link
Copy Markdown
Member

🎉 This PR has been merged—thank you, @glenn-jocher, for updating AGENTS.md to match the repository’s current tooling and CI checks, keeping contributor guidance aligned with documented validation workflows.

“Well done is better than well said.” — Benjamin Franklin

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants