Skip to content

Restore canonical AGENTS.md sections - #207

Merged
glenn-jocher merged 1 commit into
mainfrom
standardize-agents-md
Aug 2, 2026
Merged

Restore canonical AGENTS.md sections#207
glenn-jocher merged 1 commit into
mainfrom
standardize-agents-md

Conversation

@glenn-jocher

@glenn-jocher glenn-jocher commented Aug 2, 2026

Copy link
Copy Markdown
Member

Aligns AGENTS.md with the canonical version maintained in ultralytics/ultralytics.

  • Replaces a locally rewritten 8-item Core Principles list with the canonical 5 principles, Review gate, and the NEVER-push-to-main worktree paragraph, which the local copy had dropped entirely.
  • Restores the canonical 5-step PR Workflow; the local copy had collapsed steps 2 and 3 into a single tool-specific instruction.
  • Adds the repo-specific intro paragraph that every Ultralytics AGENTS.md carries between the standard header line and Core Principles.
  • The documented lint command claimed to mirror ultralytics/actions but used --target-version py39; the action targets py38 and also ignores BLE001 and S110. Since requires-python here is >=3.8, the documented command would have let pyupgrade emit 3.9-only syntax. Corrected to match the action.

Repo-specific Commands, Architecture, and Conventions sections are otherwise unchanged.

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Updates the contributor guidance for the Ultralytics MkDocs plugin with clearer development principles, review procedures, and current formatting commands. 🛠️

📊 Key Changes

  • Documented the purpose and capabilities of mkdocs-ultralytics-plugin, including SEO metadata, social cards, JSON-LD, git footers, “Copy for LLM,” and llms.txt generation.
  • Refined the core development principles to emphasize:
    • Solving issues at their source.
    • Searching for and reusing existing code.
    • Deleting or modifying code before adding new abstractions.
    • Keeping changes minimal and regression-free.
  • Added a formal review gate requiring reviewers to consider whether existing code could be changed or removed instead of adding new code.
  • Updated repository workflow guidance:
    • Always use a new Git worktree and feature branch.
    • Perform full-diff reviews and cold final reviews before merging.
    • Continue reviewing changes after bot or human commits.
  • Updated Ruff commands to target Python 3.8 and include revised lint rule selections and exclusions.

🎯 Purpose & Impact

  • 🧭 Gives AI agents and contributors clearer, more consistent instructions for making focused changes.
  • 🧹 Encourages simpler implementations, less duplication, and removal of obsolete code.
  • 🔍 Strengthens review practices to catch regressions and violations before merging.
  • ⚙️ Aligns local linting and formatting instructions more closely with the repository’s current CI behavior.
  • 🤝 Improves collaboration safety by reducing conflicts from direct edits, force pushes, or outdated review assumptions.

@UltralyticsAssistant UltralyticsAssistant added the documentation Improvements or additions to documentation label Aug 2, 2026
@UltralyticsAssistant

Copy link
Copy Markdown
Member

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/mkdocs 🚀 PR! This is an automated welcome message, and an 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/mkdocs 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

Clean PR. The restored guidance is internally consistent, and the documented Ruff command now matches the configured Ultralytics Actions flags relevant to Python 3.8 support.

@glenn-jocher
glenn-jocher merged commit 91d599c into main Aug 2, 2026
5 checks passed
@glenn-jocher
glenn-jocher deleted the standardize-agents-md branch August 2, 2026 18:16
@UltralyticsAssistant

Copy link
Copy Markdown
Member

🎉 Merged—thank you @glenn-jocher for this thoughtful improvement to the mkdocs-ultralytics-plugin contributor guidance!

“Simplicity is the ultimate sophistication.” — Leonardo da Vinci

The clearer principles, stronger review gates, safer workflow practices, and updated Ruff commands will help contributors and AI agents make smaller, more reliable changes while reducing duplication and regressions. Great work strengthening the foundation for sustainable collaboration! 🚀

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