Deep-Live-Cam
Deep-Live-Cam copied to clipboard
feat: Replace Markdown Bug Report with GitHub Issue Template
This PR replaces the previous Markdown-based bug report template (.github/ISSUE_TEMPLATE/bug_report.md) with the standard GitHub YAML issue form (.github/ISSUE_TEMPLATE/bug_report.yml).
This change leverages GitHub's built-in issue forms feature to provide a more structured and user-friendly way for contributors to report bugs, ensuring all necessary information is captured consistently.
Changes:
- Added
.github/ISSUE_TEMPLATE/bug_report.yml - Removed
.github/ISSUE_TEMPLATE/bug_report.md
This aligns with modern GitHub practices for managing issue templates.
Summary by Sourcery
Replace Markdown bug report template with a GitHub YAML issue form to improve bug reporting process
New Features:
- Implemented a structured GitHub YAML issue form for bug reporting
Documentation:
- Updated issue template to provide more comprehensive bug reporting guidance
Chores:
- Migrated from Markdown-based issue template to GitHub's native issue form
Reviewer's Guide
This pull request updates the bug reporting process by replacing the existing Markdown template with a GitHub YAML issue form, utilizing GitHub's structured issue template feature.
File-Level Changes
| Change | Details | Files |
|---|---|---|
| Replaced Markdown bug report template with a YAML-based GitHub issue form. |
|
.github/ISSUE_TEMPLATE/bug_report.yml.github/ISSUE_TEMPLATE/bug_report.md |
Tips and commands
Interacting with Sourcery
- Trigger a new review: Comment
@sourcery-ai reviewon the pull request. - Continue discussions: Reply directly to Sourcery's review comments.
- Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with
@sourcery-ai issueto create an issue from it. - Generate a pull request title: Write
@sourcery-aianywhere in the pull request title to generate a title at any time. You can also comment@sourcery-ai titleon the pull request to (re-)generate the title at any time. - Generate a pull request summary: Write
@sourcery-ai summaryanywhere in the pull request body to generate a PR summary at any time exactly where you want it. You can also comment@sourcery-ai summaryon the pull request to (re-)generate the summary at any time. - Generate reviewer's guide: Comment
@sourcery-ai guideon the pull request to (re-)generate the reviewer's guide at any time. - Resolve all Sourcery comments: Comment
@sourcery-ai resolveon the pull request to resolve all Sourcery comments. Useful if you've already addressed all the comments and don't want to see them anymore. - Dismiss all Sourcery reviews: Comment
@sourcery-ai dismisson the pull request to dismiss all existing Sourcery reviews. Especially useful if you want to start fresh with a new review - don't forget to comment@sourcery-ai reviewto trigger a new review!
Customizing Your Experience
Access your dashboard to:
- Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others.
- Change the review language.
- Add, remove or edit custom review instructions.
- Adjust other review settings.
Getting Help
- Contact our support team for questions or feedback.
- Visit our documentation for detailed guides and information.
- Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.
Addressed the feedback on the bug_report.yml issue template:
- Updated the link in the "Code of Conduct" section to point to the
CONTRIBUTING.mdfile as requested. - Left the
assigneesfield empty ([]) as there are currently no specific default assignees or teams designated for automatic assignment on this project. Issues can be assigned manually by maintainers as needed.
Hi team! Just checking in on this PR. It aims to improve the bug reporting process by adopting GitHub's issue forms. I'm open to feedback or suggestions. Let me know if any changes are needed. Thanks!
Hi team, just following up on this PR.
I addressed the feedback provided earlier and made the requested updates to the issue form. Let me know if there's anything else you'd like me to tweak before merging. Appreciate your time and review!
Thanks again.