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 Issue Templates with πŸ’‘ ProTip! #5539

Merged
merged 3 commits into from
Nov 6, 2021
Merged

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Nov 6, 2021

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Improved issue templates for bug reports and questions.

πŸ“Š Key Changes

  • Changed the placeholder text in the bug report template to support block formatting for better clarity.
  • Updated the code placeholder in bug reports to be inside a code block for easier readability.
  • Simplified placeholder instructions by removing verbose tips in both bug report and question templates.

🎯 Purpose & Impact

  • Enhanced Readability: By using code blocks, users can more easily format their example code, leading to clearer, more understandable issues. πŸ“
  • Focused Information: Clear and concise placeholders encourage users to provide only the necessary information, making it easier for maintainers to diagnose and address issues. πŸ”
  • User-Friendly Reporting: Streamlining the placeholders lowers the barrier for reporting issues, potentially increasing community engagement and contributions. 🀝

@glenn-jocher glenn-jocher self-assigned this Nov 6, 2021
@glenn-jocher glenn-jocher merged commit 76d90d8 into master Nov 6, 2021
@glenn-jocher glenn-jocher deleted the update/issues branch November 6, 2021 12:58
BjarneKuehl pushed a commit to fhkiel-mlaip/yolov5 that referenced this pull request Aug 26, 2022
* Update bug-report.yml

* Update question.yml

* Update bug-report.yml
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant