Skip to content

Conversation

@gitauto-ai
Copy link

@gitauto-ai gitauto-ai bot commented Mar 7, 2025

Why is this feature needed?

The community relies on well-defined issue templates to report bugs and suggest new features. Adding a bug report and feature request template standardizes the issue reporting process. This consistency helps maintainers quickly gather the required information, identify problems, and understand proposed improvements.

What and how are we changing? Why this approach?

This pull request introduces two new issue templates located in the .github/ISSUE_TEMPLATE directory:

  • bug_report.yml: This template is designed for users to submit detailed bug reports, including reproduction steps, logs, device and environment details.
  • feature_request.yml: This template allows users to request new features while providing context about the problem, current solutions, and any proposed improvements.

Using YAML for templates ensures simplicity and easy maintenance. The templates include placeholder text and validations to guide users in providing all necessary information, which ultimately improves the quality and clarity of contributions.

What actions are required from users?

Users reporting bugs or requesting features should:

  • Use the "Bug Report" template when encountering issues, ensuring all required fields are completed.
  • Use the "Feature Request" template to suggest improvements, filling in details about the problem, current workaround, and the expected solution.
    There is no need for any manual configuration from contributors; they only need to select and use the appropriate template when creating an issue.

How does it work? (Technical details)

  • Both templates are YAML files placed in the .github/ISSUE_TEMPLATE folder.
  • The bug_report.yml template collects detailed information such as bug behavior, logs, reproduction steps, and device details.
  • The feature_request.yml template collects the problem description, current workaround, proposed solution, and any additional attachments.
  • The templates are defined with required validations (where necessary) to ensure essential information is included for proper issue triage.

Is it backwards compatible?

Yes, adding these templates is fully backwards compatible. They will simply be available for issue creation on GitHub without affecting existing issues or workflows.

Any other considerations?

  • The templates include a "gitauto" label to facilitate automatic issue labeling.
  • Additional fields or validations can be updated in future iterations based on feedback from users and maintainers.
  • The current placeholder texts are written in a clear, instructional manner to help users provide the necessary details.
  • This change helps maintain a consistent and efficient issue management process across the project.

@gitauto-ai gitauto-ai bot requested a review from isabella232 March 7, 2025 09:24
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