Skip to content

Conversation

aryan-dani
Copy link

@aryan-dani aryan-dani commented Apr 30, 2025

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

Copy link
Contributor

sourcery-ai bot commented Apr 30, 2025

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.
  • Added a new YAML configuration file (bug_report.yml) defining the issue form structure.
  • Removed the old Markdown template file (bug_report.md).
.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 review on 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 issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on 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 dismiss on 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 review to 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

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @aryan-dani - I've reviewed your changes - here's some feedback:

  • Update the placeholder link to the Code of Conduct in the new issue form.
  • Consider adding default assignees or a team to the assignees field in the issue form for faster triage.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@aryan-dani
Copy link
Author

Addressed the feedback on the bug_report.yml issue template:

  • Updated the link in the "Code of Conduct" section to point to the CONTRIBUTING.md file as requested.
  • Left the assignees field 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.

@aryan-dani
Copy link
Author

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!

@aryan-dani
Copy link
Author

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.

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