Skip to content

Add AGENTS.md and CLAUDE.md, disable Python formatting, fix OSI link - #30

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

Add AGENTS.md and CLAUDE.md, disable Python formatting, fix OSI link#30
glenn-jocher merged 2 commits into
mainfrom
standardize-agents-md

Conversation

@glenn-jocher

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

Copy link
Copy Markdown
Member

Standardizes this repository's AI agent guidance and fixes two inaccuracies.

  • Add AGENTS.md with the standard Ultralytics Core Principles and PR Workflow sections, plus a short repo-specific intro noting that this is a shared function library consumed via addpath by other Ultralytics MATLAB repos, so exported fcn*.m signatures should stay backward compatible.
  • Add CLAUDE.md as a symlink to AGENTS.md so both filenames resolve to one source of truth.
  • Set python: false in format.yml. This repository contains no Python files, so the Ruff/docformatter step was doing nothing on every run.
  • Fix the OSI license link in the README, which used the legacy agpl-v3 slug that now redirects, to the canonical agpl-3.0 URL used across the org.

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Improves repository maintenance by aligning formatting automation, documenting contribution guidance, and reformatting bundled mapping HTML files. ✨

📊 Key Changes

  • Disabled Python formatting in the GitHub workflow because the repository contains no Python files.
  • Added AGENTS.md with guidance for AI coding agents, API compatibility, development practices, and PR workflows.
  • Added CLAUDE.md as a symlink to AGENTS.md for Claude Code compatibility.
  • Corrected the AGPL-3.0 license URL in the README.
  • Reformatted inline JavaScript tracking handlers across Natural Earth mapping documentation files for improved readability and consistent formatting.

🎯 Purpose & Impact

  • Reduces unnecessary CI formatting work and avoids applying Python tools to a MATLAB-only repository. ⚙️
  • Gives contributors and AI agents clearer instructions for making safe, backward-compatible changes.
  • Improves consistency and maintainability of HTML documentation without changing mapping data or user-facing functionality.
  • Fixes the license reference and preserves existing download and outbound-link tracking behavior. 📚

@UltralyticsAssistant UltralyticsAssistant added devops GitHub Devops or MLops documentation Improvements or additions to documentation labels Aug 2, 2026
@UltralyticsAssistant

Copy link
Copy Markdown
Member

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/functions-matlab 🚀 PR! To ensure a seamless integration of your work, please review the following checklist. This is an automated message, and an engineer will assist with any questions or review needs:

  • 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/functions-matlab 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 workflow change matches the repository contents, the guidance files are correctly linked through the symlink, and the README license URL update is scoped and correct.

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

Copy link
Copy Markdown
Member

🎉 Thank you, @glenn-jocher, for this valuable maintenance PR!

“Great things are done by a series of small things brought together.” — Vincent van Gogh

This merge brings thoughtful improvements to the MATLAB repository: leaner CI formatting, clearer contributor and AI-agent guidance, a corrected license reference, and more consistent mapping documentation formatting—all while preserving existing functionality. Your careful work helps keep the project maintainable, accessible, and ready for future contributions. 🙌

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