Skip to content

Add Simplified Chinese README#171

Merged
glenn-jocher merged 2 commits into
mainfrom
add-chinese-readme
Jun 5, 2026
Merged

Add Simplified Chinese README#171
glenn-jocher merged 2 commits into
mainfrom
add-chinese-readme

Conversation

@glenn-jocher

@glenn-jocher glenn-jocher commented Jun 5, 2026

Copy link
Copy Markdown
Member

Summary

  • tighten the English README around asset usage, repository layout, licensing, and contact paths
  • add a Simplified Chinese README that mirrors the updated English structure
  • clean up workflow token usage and honor the existing release publish input

Validation

  • npx prettier --check README.md README.zh-CN.md .github/workflows/format.yml .github/workflows/tag.yml
  • actionlint .github/workflows/*.yml
  • independent Codex review addressed

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

🛠️ This PR streamlines GitHub workflows and refreshes the repository documentation, making ultralytics/assets clearer to use, easier to maintain, and more accessible with a new Chinese README.

📊 Key Changes

  • 🔐 Updated GitHub Actions to use secrets.GITHUB_TOKEN consistently instead of the custom _GITHUB_TOKEN.
  • 🚫 Disabled Python formatting in format.yml since this repository does not contain Python source files.
  • 🤖 Disabled automated PR review approval in format.yml, noting that GitHub Actions cannot approve PRs.
  • 🧹 Improved tag.yml shell safety and reliability by quoting tag names and output paths.
  • 🎯 Added a condition so release publishing only runs when publish_release == 'true'.
  • 📘 Reworked the main README.md to better explain what this repository contains:
    • visual assets
    • pretrained model files
    • dataset assets
  • 🌍 Added bilingual navigation and a full new Simplified Chinese README: README.zh-CN.md.
  • 🗂️ Updated repository structure documentation to better reflect current folders and asset categories.
  • ✨ Simplified and clarified contribution, license, contact, and usage guidance across the docs.

🎯 Purpose & Impact

  • ✅ Reduces workflow confusion by aligning automation settings with how this repository is actually used.
  • 🔒 Improves security and maintainability by standardizing token usage and tightening workflow behavior.
  • 🧯 Lowers the chance of tagging or release errors with safer shell scripting and conditional release execution.
  • 📚 Makes the repository much easier for users to understand, especially those looking for logos, docs media, models, or dataset files.
  • 🌐 Expands accessibility for Chinese-speaking users, helping a broader community navigate and use Ultralytics assets.
  • 🚀 Overall, this PR is mostly a documentation and CI quality-of-life update, with little impact on end-user functionality but meaningful improvements for repository clarity and release reliability.

@github-actions github-actions Bot added devops GitHub Devops or MLops documentation Improvements or additions to documentation enhancement New feature or request labels Jun 5, 2026
@github-actions

github-actions Bot commented Jun 5, 2026

Copy link
Copy Markdown

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/assets 🚀 PR! This is an automated message to help with review readiness, and an engineer will assist you shortly. Please review the checklist below for a smooth integration 😊

  • 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 force-pushed the add-chinese-readme branch 2 times, most recently from 6f71e03 to c875ab3 Compare June 5, 2026 17:14
@glenn-jocher glenn-jocher merged commit 03bd31d into main Jun 5, 2026
3 checks passed
@glenn-jocher glenn-jocher deleted the add-chinese-readme branch June 5, 2026 17:21
@github-actions

github-actions Bot commented Jun 5, 2026

Copy link
Copy Markdown

🎉 Merged — thank you, @glenn-jocher!

“As we look ahead into the next century, leaders will be those who empower others.” — Bill Gates

This update does exactly that: cleaner workflows, safer release logic, clearer repository guidance, and a new Chinese README that makes ultralytics/assets more accessible to a broader global community. It’s a thoughtful quality-of-life improvement that strengthens maintainability while helping more users quickly find and use the assets they need.

Really appreciate the care put into both the CI refinements and the documentation polish.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant