Skip to content

Conversation

@gitauto-ai
Copy link

@gitauto-ai gitauto-ai bot commented Feb 14, 2025

Why is this feature needed?

Adding standardized issue templates helps improve issue quality by guiding users to provide all the necessary information when reporting bugs or suggesting new features. This makes it easier for maintainers to triage, reproduce, and address reported issues efficiently, while also ensuring that contributors know exactly what information to provide.

What and how are we changing? Why this approach?

• Two new issue templates have been added to the repository:

  • A Bug Report template (.github/ISSUE_TEMPLATE/bug_report.yml) that guides users through providing detailed information about bugs, including the bug behavior, logs, reproduction steps, expected behavior, and additional system details.
  • A Feature Request template (.github/ISSUE_TEMPLATE/feature_request.yml) that helps users articulate their problem, outline their current solution, and propose a future enhancement.

By using structured YAML files for these templates, GitHub’s new issue creation interface can automatically prompt users to supply complete information. This approach minimizes the back-and-forth communication needed to gather details during issue triaging.

What actions are required from users?

• No immediate action is required from current contributors.
• When creating a new issue, users will see an option to choose between the bug report and feature request templates, ensuring they provide the necessary details from the start.
• Users are encouraged to update their issue submissions with as much detail as possible to help maintainers address problems quickly.

How does it work? (Technical details)

• The two YAML files under the .github/ISSUE_TEMPLATE directory define the structure and required fields for each issue type.
• Each template specifies field labels, descriptions, placeholders, and validations to ensure the submitted information is both complete and relevant.
• When a user clicks on “New Issue” in GitHub, these templates will be detected and offered as options, letting the user pick the appropriate template based on their needs.

Is it backwards compatible?

Yes, these changes only add new issue templates and do not affect any existing functionality or issues. Users who choose not to use a template will still be able to create issues as before.

Any other considerations?

• Future improvements may include revising fields or adding more templates based on user feedback.
• Maintainers should periodically review the submitted issues to ensure the templates continue to meet the team’s needs.
• With clear guidelines now in place, the overall quality of issue tracking is expected to improve, leading to more efficient debugging and feature implementation processes.


@gitauto-ai gitauto-ai bot requested a review from browser-vm February 14, 2025 13:24
@sourcery-ai
Copy link

sourcery-ai bot commented Feb 14, 2025

Reviewer's Guide by Sourcery

This pull request introduces two new issue templates to the repository: one for bug reports and another for feature requests. These templates provide a structured format for users to submit issues, ensuring that all necessary information is included. The templates are written in YAML format and include fields for describing the issue, steps to reproduce, expected behavior, and other relevant details.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added a bug report issue template.
  • Created a YAML file defining the structure and fields for bug reports.
  • Included fields for describing the bug, logs, screenshots, steps to reproduce, expected behavior, possible cause, device information, OS, browser, and additional information.
  • Defined validations for required fields to ensure that users provide all necessary information.
.github/ISSUE_TEMPLATE/bug_report.yml
Added a feature request issue template.
  • Created a YAML file defining the structure and fields for feature requests.
  • Included fields for describing the problem, current solution, proposed solution, attachments, and additional information.
  • Defined validations for required fields to ensure that users provide all necessary information.
.github/ISSUE_TEMPLATE/feature_request.yml

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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

@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.

We have skipped reviewing this pull request. It seems to have been created by a bot (hey, gitauto-ai[bot]!). We assume it knows what it's doing!

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