Skip to content

Add AGENTS.md agent guidance with CLAUDE.md symlink#177

Merged
glenn-jocher merged 3 commits into
mainfrom
agents-md
Jul 4, 2026
Merged

Add AGENTS.md agent guidance with CLAUDE.md symlink#177
glenn-jocher merged 3 commits into
mainfrom
agents-md

Conversation

@glenn-jocher

@glenn-jocher glenn-jocher commented Jul 4, 2026

Copy link
Copy Markdown
Member

Summary

Adds AGENTS.md with guidance for AI coding agents working in this repository, with CLAUDE.md as a relative symlink to it.

  • AGENTS.md: Core Principles, PR workflow, verified commands (prettier/codespell as run by format.yml), architecture notes (raw-URL asset serving on main, model weights via GitHub Releases, tag.yml release gating), and repo conventions.
  • README.md / README.zh-CN.md: add the missing documents/ entry (Contributor License Agreement) to the Repository Layout section in both READMEs.

No asset files are changed.

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Adds AI-agent contribution guidance and documents the new documents/ asset directory for legal/policy files 📚

📊 Key Changes

  • Added AGENTS.md with repository-specific guidance for AI coding agents like Claude Code 🤖
  • Added CLAUDE.md as a symlink to AGENTS.md for Claude-compatible tooling 🔗
  • Documented core contribution principles: keep changes minimal, prefer deletion/replacement over adding code, avoid duplication, and protect existing workflows ✅
  • Added PR workflow instructions covering formatting, review, rebasing, and cleanup 🛠️
  • Clarified repository architecture, including static asset usage and release-hosted model/dataset binaries 📦
  • Updated both English and Chinese READMEs to include the new documents/ directory for legal and policy documents 🌐

🎯 Purpose & Impact

  • Helps AI agents and contributors work consistently with Ultralytics standards, reducing unnecessary complexity and regressions 🚀
  • Improves maintainability by emphasizing simple, production-ready changes and careful handling of public asset paths 🧹
  • Makes repository structure clearer for users browsing assets, especially legal documents like the Contributor License Agreement 📄
  • Keeps multilingual documentation aligned, improving accessibility for both English and Chinese readers 🤝

@github-actions github-actions Bot added devops GitHub Devops or MLops documentation Improvements or additions to documentation labels Jul 4, 2026
@github-actions

github-actions Bot commented Jul 4, 2026

Copy link
Copy Markdown

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/assets 🚀 PR! This automated message is here to help with a smooth review, and an Ultralytics engineer will assist as needed. 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/assets 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! 🚀

@glenn-jocher glenn-jocher merged commit bb516ed into main Jul 4, 2026
3 checks passed
@glenn-jocher glenn-jocher deleted the agents-md branch July 4, 2026 20:59
@github-actions

github-actions Bot commented Jul 4, 2026

Copy link
Copy Markdown

🚀 Merged — thank you @glenn-jocher, with contributions from @UltralyticsAssistant!

“Give me six hours to chop down a tree and I will spend the first four sharpening the axe.” — Abraham Lincoln

This PR sharpens the axe for future contributors and AI agents by adding clear repository guidance, aligning Claude-compatible tooling, and documenting the new documents/ directory for legal and policy assets. These updates help keep contributions minimal, consistent, and production-ready while improving clarity across both English and Chinese documentation.

Great work strengthening the foundation for faster, safer, and more maintainable collaboration across Ultralytics assets!

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

Labels

devops GitHub Devops or MLops documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants