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

Add default author feature #125

Merged
merged 17 commits into from
Jan 29, 2025
Merged

Add default author feature #125

merged 17 commits into from
Jan 29, 2025

Conversation

glenn-jocher
Copy link
Member

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

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Enhanced the Ultralytics MkDocs plugin by adding default author support and improved metadata handling for better customization and fallback logic.

📊 Key Changes

  • Added default_author configuration option to define a fallback GitHub author email if no author data is found in files.
  • Introduced constants for default creation and modification dates to handle cases where Git history lacks this information.
  • Updated get_github_usernames_from_file to use a default author when none are available.
  • Bumped plugin version from 0.1.15 to 0.1.16.

🎯 Purpose & Impact

  • Better Metadata Customization: Users can now set a default author, ensuring accurate crediting even when file-specific author data is missing.
  • Robust Handling of Missing Data: Provides fallback dates and author info, increasing reliability in building documentation with incomplete Git history.
  • Improved User Control: Enhances the flexibility of the metadata generation process for tailored documentation needs.
  • Plugin Update Tracking: The version bump signals this improvement for easier version control.

🚀 These updates simplify metadata management and ensure seamless user experiences when using the MkDocs plugin!

@UltralyticsAssistant UltralyticsAssistant added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 29, 2025
@UltralyticsAssistant
Copy link
Member

👋 Hello @glenn-jocher, thank you for submitting an ultralytics/mkdocs 🚀 PR! 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/mkdocs 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: Ensure that all updates, such as the new default_author or modified metadata functionalities, are reflected in the documentation.
  • Add Tests: If applicable, include or update tests to cover your changes. For example, ensure the new fallback mechanisms (like default_author) and timestamp behavior (TODAY) are thoroughly tested, and confirm that all tests are passing.
  • Sign the CLA: If this is your first Ultralytics PR, kindly confirm you have signed our Contributor License Agreement by commenting, "I have read the CLA Document and I sign the CLA."
  • Minimize Changes: Limit your changes to the minimum necessary for your enhancements. As Bruce Lee says, "It is not daily increase but daily decrease, hack away the unessential." 🚀

For additional guidance, please refer to our Contributing Guide. If you have further questions, don’t hesitate to leave a comment.

⚙️ Note: This is an automated response to guide you through the process. An Ultralytics engineer will review and assist with your PR soon. Thank you for your contribution! 🎉

@glenn-jocher glenn-jocher merged commit 8f7d73b into main Jan 29, 2025
3 checks passed
@glenn-jocher glenn-jocher deleted the default-author branch January 29, 2025 18:57
@UltralyticsAssistant
Copy link
Member

🎉 Great news! The PR by @glenn-jocher has been merged! Your enhancements to the Ultralytics MkDocs plugin are a testament to craftsmanship and resourcefulness. From default author support to better metadata handling, your efforts make documentation more reliable, customizable, and impactful for users worldwide. 🌟

As Marcus Aurelius once said, "What we do now echoes in eternity." Your work will resonate through the contributions of those empowered by this plugin. Thank you for making technology and collaboration better for everyone! 🚀

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 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants