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

Update mkdocs_github_authors.yaml #43

Merged
merged 1 commit into from
Jan 29, 2025
Merged

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Jan 29, 2025

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Added an expanded list of GitHub contributors with their corresponding metadata (e.g., avatars, usernames) to enhance documentation visibility and community recognition.

📊 Key Changes

  • Extended the mkdocs_github_authors.yaml file with a detailed list of contributors, including:
    • GitHub usernames.
    • Profile avatars.
    • Email/user ID associations.
  • Recognizes both public profiles and anonymous contributors with placeholder fields where necessary.

🎯 Purpose & Impact

  • Recognition: 🌟 Highlights and credits a broader range of contributors, fostering community transparency and acknowledgment.
  • Improved Documentation: 📚 Supports auto-generation of contributor metadata for cleaner, richer documentation.
  • Community Engagement: 🤝 Encourages participation by providing public recognition for contributions.

Copy link

vercel bot commented Jan 29, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
handbook ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 29, 2025 7:08pm

@UltralyticsAssistant UltralyticsAssistant added the documentation Improvements or additions to documentation label Jan 29, 2025
@UltralyticsAssistant
Copy link
Member

👋 Hello @glenn-jocher, thank you for submitting an ultralytics/handbook 🚀 PR! To ensure a smooth review and integration process, here’s a quick checklist to guide you:

  • Define a Purpose: Clearly explain the purpose and intent of your changes in the PR description. You've done a great job outlining the summary, purpose, and impact—thanks for that! 👍 Ensure your commit messages follow the project's conventions for clarity.
  • Synchronize with Source: Confirm your PR is up-to-date with the main branch of the ultralytics/handbook repository. If it's behind, update it by clicking the 'Update branch' button or running git fetch && git rebase origin/main locally.
  • Ensure CI Checks Pass: Verify that all Ultralytics CI checks are passing for your contributions. If any checks fail, review the logs and address the issues as needed.
  • Update Documentation: If your changes require updates to documentation, make sure to include them. Leverage the Ultralytics documentation for reference.
  • Add Tests: Check if any tests are necessary for your updates. While documentation changes may not require tests, keep this in mind for script-related updates.
  • Sign the CLA: If this is your first PR to the repository, please ensure you’ve signed the Contributor License Agreement (CLA). State “I have read the CLA Document and I sign the CLA” in a comment here if you haven’t done so already.
  • Minimize Changes: Focus on including only the necessary changes related to this specific update. Your streamlined approach to improving contributor visibility looks spot-on. 🌟

For further assistance, feel free to check out our Contributing Guide. If you encounter any issues or have questions, don’t hesitate to leave a comment in this PR. An Ultralytics engineer will review your submission and get back to you soon. 🚀

Thank you for your contributions to Ultralytics and for fostering collaboration within the community! 🎉👏

@glenn-jocher glenn-jocher merged commit ebf1322 into main Jan 29, 2025
3 checks passed
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch January 29, 2025 19:11
@UltralyticsAssistant
Copy link
Member

🚀 PR Merged! Huge thanks to @glenn-jocher for this impactful contribution! Your work amplifies the voices of our incredible community, reminding us that every contributor matters. Now, more people can see and celebrate the faces and efforts behind the code—this is how we build together. 🌟✨

As Marcus Aurelius once said, "What we do now echoes in eternity." Your addition to recognizing contributors ensures these echoes inspire even more collaboration and innovation. Thank you for making a difference! 💛

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