Skip to content

Issue templates#35

Merged
glenn-jocher merged 4 commits intomainfrom
templates
Nov 16, 2025
Merged

Issue templates#35
glenn-jocher merged 4 commits intomainfrom
templates

Conversation

@glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Nov 16, 2025

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Adds structured GitHub issue templates for bugs, feature requests, and questions to streamline support and contributions for Ultralytics CLIP. ✨

📊 Key Changes

  • 🐛 Introduces a dedicated Bug Report template with fields for environment, minimal reproducible example, and detailed issue description.
  • 🚀 Adds a Feature Request template focusing on feature description, use case, and optional willingness to submit a PR.
  • ❓ Creates a Question template that encourages users to include detailed context, code, and logs.
  • 🔗 Configures config.yml to:
    • Keep blank issues enabled.
    • Add quick-access links to the CLIP README, Ultralytics community forum, Discord, and Reddit.
  • ✅ All templates enforce a “search before asking” checkbox to reduce duplicates and improve issue quality.

🎯 Purpose & Impact

  • 📥 Makes it easier for users to report problems and request features in a clear, consistent format.
  • 🧭 Helps maintainers triage and route issues faster by categorizing project areas and standardizing information.
  • 🧪 Improves reproducibility of bugs through structured environment and example sections, speeding up fixes.
  • 🤝 Encourages community contributions by explicitly inviting users to submit PRs and pointing them to the Contributing Guide.
  • 🌐 Strengthens community support by directing users to appropriate channels (docs, forum, Discord, Reddit) for help and discussion.

@UltralyticsAssistant UltralyticsAssistant added devops GitHub Devops or MLops documentation Improvements or additions to documentation labels Nov 16, 2025
@UltralyticsAssistant
Copy link
Member

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/CLIP 🚀 PR! This is an automated review assistant; a human engineer will be with you shortly. In the meantime, 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/CLIP 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! 🚀

Copy link
Member

@UltralyticsAssistant UltralyticsAssistant left a comment

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

Overall the issue templates are well-structured and will significantly improve the quality of incoming reports and questions. The main improvements are to avoid unsupported root-level type fields in the bug and feature templates and to slightly tighten the environment guidance in the bug template to better reflect typical Ultralytics CLIP usage.

💬 Posted 3 inline comments

glenn-jocher and others added 2 commits November 16, 2025 17:47
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: Ultralytics Assistant <135830346+UltralyticsAssistant@users.noreply.github.com>
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
@glenn-jocher glenn-jocher merged commit 19870ea into main Nov 16, 2025
5 checks passed
@glenn-jocher glenn-jocher deleted the templates branch November 16, 2025 16:48
@UltralyticsAssistant
Copy link
Member

Merged – and what an awesome quality-of-life boost for Ultralytics CLIP! 🎉

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

These structured issue templates are exactly that: thoughtful pieces that, together, will make our support, triage, and community collaboration smoother and more scalable. From clearer bug reports to more focused feature requests and questions, this will save maintainers time while giving users a better experience and clearer path to contribute.

Huge thanks @glenn-jocher for investing in the long-term health of the project and making it easier for everyone to build with CLIP and Ultralytics HUB. 🙌

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants