Skip to content

Add AGENTS.md and correct README feature claims - #21

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

Add AGENTS.md and correct README feature claims#21
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
  • Add AGENTS.md with the standard Ultralytics Core Principles and PR Workflow, plus repo-specific Commands, Architecture, and Conventions derived from source/run_repo.py. CLAUDE.md is a symlink to it.
  • README.md Features: the "Metadata Tracking" bullet claimed the tool captures the author and commit date for each duplication, and "Comprehensive Statistics" claimed a breakdown by author. Neither is implemented — run_repo.py never reads Git history, and calculate_statistics() returns only the duplicated-line count and the number of distinct files on each side. Rewrote the three bullets to describe what the tool actually reports.
  • pyproject.toml: classifiers stopped at Python 3.11 while requires-python is >=3.8; extended them through 3.14.

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Clarifies source-trace behavior and contributor guidance while extending declared Python support through Python 3.14. 🧭🐍

📊 Key Changes

  • Added AGENTS.md with detailed instructions for AI coding agents, repository architecture, workflows, conventions, and validation commands.
  • Added CLAUDE.md as a symlink to AGENTS.md for Claude Code compatibility.
  • Updated the README to accurately describe:
    • Line-level duplicate-code comparison and filtering.
    • Summary statistics for files and duplicated lines.
    • Source and destination file pairs for each match.
  • Removed outdated README claims about author, commit-date, and per-author metadata tracking.
  • Declared support for Python 3.12, 3.13, and 3.14 in pyproject.toml.

🎯 Purpose & Impact

  • 🛠️ Gives AI agents and contributors clear, consistent guidelines for making minimal, safe changes.
  • 📖 Makes user-facing documentation better aligned with the tool’s actual line-based comparison behavior.
  • 🔍 Improves transparency by explaining how duplicated lines can be traced between repositories.
  • 🐍 Signals compatibility with newer Python releases, helping users run the tool on modern environments.
  • ✅ Reduces confusion about unsupported features such as Git history, authorship, and commit-date analysis.

@UltralyticsAssistant UltralyticsAssistant added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 2, 2026
@UltralyticsAssistant

Copy link
Copy Markdown
Member

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/source-trace 🚀 PR! This automated message helps keep contributions on track, and an engineer will assist with the review. 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/source-trace 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 README feature descriptions align with the current comparison and statistics behavior, AGENTS.md accurately documents the repository structure and workflow, the CLAUDE.md symlink is correctly represented, and the added Python classifiers are valid.

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

Copy link
Copy Markdown
Member

🎉 Merged—thank you, @glenn-jocher, for this thoughtful and impactful contribution!

“The important thing is to never stop questioning.” — Albert Einstein

By clarifying source-trace’s line-level behavior, improving contributor and AI-agent guidance, and extending support through Python 3.14, this PR makes the project easier to understand, maintain, and use with confidence. Your careful documentation updates help the community ask better questions—and find clearer answers. 🚀

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 enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants