Skip to content

Document the three-number PyPI release policy - #49

Merged
glenn-jocher merged 2 commits into
mainfrom
docs/pypi-release-policy
Sep 7, 2026
Merged

Document the three-number PyPI release policy#49
glenn-jocher merged 2 commits into
mainfrom
docs/pypi-release-policy

Conversation

@glenn-jocher

@glenn-jocher glenn-jocher commented Sep 7, 2026

Copy link
Copy Markdown
Member

Record the organization-wide rule that Ultralytics-owned PyPI packages use only three-number MAJOR.MINOR.PATCH releases, advance patch versions, and never add suffixes or bypass publishing guards.

Adds one instruction line to AGENTS.md. No runtime or release workflow changes.

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Documents the three-number versioning policy for Ultralytics-owned PyPI packages in AGENTS.md.

📊 Key Changes

  • Adds a convention requiring MAJOR.MINOR.PATCH package versions.
  • Prohibits version suffixes.
  • Leaves runtime code and release workflows unchanged.

🎯 Purpose & Impact

  • Guides contributors and automation when assigning versions to Ultralytics-owned PyPI packages.
  • No user-facing change.

@UltralyticsAssistant UltralyticsAssistant added the documentation Improvements or additions to documentation label Sep 7, 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. The change is limited to documenting the stated PyPI release policy in AGENTS.md and introduces no runtime, generation, or release-workflow behavior changes.

@glenn-jocher
glenn-jocher merged commit 1d85187 into main Sep 7, 2026
4 checks passed
@glenn-jocher
glenn-jocher deleted the docs/pypi-release-policy branch September 7, 2026 17:25
@UltralyticsAssistant

Copy link
Copy Markdown
Member

🎉 PR #49 was merged! Thank you, @glenn-jocher, for documenting the MAJOR.MINOR.PATCH versioning policy for Ultralytics-owned PyPI packages.

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

This focused documentation update gives contributors and automation clear versioning guidance while leaving runtime code and release workflows unchanged.

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