Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix mkdocs_github_authors.yaml author LexBarou #19334

Merged
merged 1 commit into from
Feb 20, 2025
Merged

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Feb 20, 2025

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Minor update to author information in the documentation configuration.

📊 Key Changes

  • Fixed the username entry for "[email protected]" in docs/mkdocs_github_authors.yaml by removing an unnecessary URL format.

🎯 Purpose & Impact

  • 🛠️ Purpose: Simplifies and standardizes the author's username entry for consistency and accuracy in the documentation.
  • 🌟 Impact: No functional changes to the codebase, but improves the accuracy of documentation metadata for contributors.

@glenn-jocher glenn-jocher changed the title Fix mkdocs_github_authors.yaml Fix mkdocs_github_authors.yaml LexBarou Feb 20, 2025
@glenn-jocher glenn-jocher changed the title Fix mkdocs_github_authors.yaml LexBarou Fix mkdocs_github_authors.yaml LexBarou Feb 20, 2025
@UltralyticsAssistant UltralyticsAssistant added the documentation Improvements or additions to documentation label Feb 20, 2025
@UltralyticsAssistant
Copy link
Member

👋 Hello @glenn-jocher, thank you for submitting an ultralytics/ultralytics 🚀 pull request! 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 if applicable. Ensure your commit messages are clear, concise, and align with project conventions.
  • Synchronize with Source: Confirm your PR is synchronized with the latest main branch of ultralytics/ultralytics. If it's behind, update it either via the 'Update branch' button here on GitHub or by running git pull and git merge main locally.
  • Ensure CI Checks Pass: Verify that all Ultralytics Continuous Integration (CI) checks are passing. If any checks fail, please address the issues or let us know if assistance is required.
  • Update Documentation: If related, update the appropriate documentation to reflect the changes made in this PR.
  • Sign the CLA: If this is your first contribution to Ultralytics, make sure you’ve signed the Contributor License Agreement (CLA) by commenting "I have read the CLA Document and I sign the CLA."
  • Minimize Changes: Limit all modifications to the absolute minimum necessary for the intended fix or feature. As Bruce Lee said, "Hack away the unessential." This ensures a cleaner and more maintainable repository.

🔍 Review Notes:

  • The edits appear minor yet valuable, addressing metadata consistency in the mkdocs_github_authors.yaml file, which benefits future documentation readability and standardization. 🛠️
  • 💡 Please ensure that no unintended edits or changes have been included in the PR.

For additional tips and guidance, feel free to check out our Contributing Guide. This is an automated response, but an Ultralytics engineer will review your PR in detail and provide any further feedback soon. 🚀

Thank you for helping improve the Ultralytics ecosystem! 🌟

@glenn-jocher glenn-jocher changed the title Fix mkdocs_github_authors.yaml LexBarou Fix mkdocs_github_authors.yaml user LexBarou Feb 20, 2025
@glenn-jocher glenn-jocher changed the title Fix mkdocs_github_authors.yaml user LexBarou Fix mkdocs_github_authors.yaml author LexBarou Feb 20, 2025
@glenn-jocher glenn-jocher merged commit 5fdf46e into main Feb 20, 2025
15 checks passed
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch February 20, 2025 14:49
Copy link

codecov bot commented Feb 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.22%. Comparing base (f3838b2) to head (fdebee7).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #19334      +/-   ##
==========================================
- Coverage   73.29%   73.22%   -0.08%     
==========================================
  Files         129      129              
  Lines       17570    17570              
==========================================
- Hits        12878    12865      -13     
- Misses       4692     4705      +13     
Flag Coverage Δ
Benchmarks 34.08% <ø> (-0.04%) ⬇️
GPU 37.88% <ø> (ø)
Tests 67.01% <ø> (-0.04%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@UltralyticsAssistant
Copy link
Member

🎉 Big thanks for your contribution, @glenn-jocher! As Winston Churchill once said, "To each, there comes a time when they are figuratively tapped on the shoulder to do a great work." Your keen eye for detail and dedication to even the smallest improvements ensures a polished documentation experience for all. Consistency is the cornerstone of quality—thank you for reinforcing that standard! 🚀🙌

picsalex pushed a commit that referenced this pull request Feb 24, 2025
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