Skip to content

Add 2 issue templates #5

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

gitauto-ai[bot]
Copy link

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

Why is this feature needed?

To streamline issue reporting and improve clarity in our project management, we are adding two new issue templates: one for bug reports and another for feature requests. This helps ensure consistent, complete, and actionable information is provided when issues or enhancement requests are submitted.

What and how are we changing? Why this approach?

We have added two YAML files under the .github/ISSUE_TEMPLATE directory:
• bug_report.yml – Provides a structured form for users to report bugs, capturing essential details such as bug behavior, logs, and steps to reproduce.
• feature_request.yml – Offers a template for submitting feature requests, guiding users to describe the problem, current workarounds, and proposed solutions.
This approach leverages GitHub’s native support for issue templates, ensuring that every report or request contains the necessary information to help us triage and resolve issues efficiently.

What actions are required from users?

Users do not need to perform any configuration changes. When creating a new issue, GitHub will automatically provide these templates as options. We encourage everyone to use the relevant template to report bugs or request features, ensuring a complete context that will aid in faster issue resolution.

How does it work? (Technical details)

  • The two YAML files in the .github/ISSUE_TEMPLATE folder define the layouts, questions, placeholders, and validations for the respective issue types.
  • GitHub reads these YAML configurations and presents formatted forms when users open a new issue.
  • Each template includes multiple fields (text areas, inputs), which ensure that essential information like reproduction steps, logs, and device/browser details for bugs, or problem statements and current solutions for feature requests, is clearly provided.

Is it backwards compatible?

Yes, these changes are fully backwards compatible. They are entirely additive and do not interfere with the existing issue reporting workflow. Users still have the option to bypass the templates if they prefer to submit issues directly.

Any other considerations?

Feedback is welcome. As we use these templates, we expect to learn more about the kind of information that is most helpful. Contributions or suggestions to optimize these templates for our project’s needs are appreciated.


@gitauto-ai gitauto-ai bot requested a review from akshayna7 March 11, 2025 07:32
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.

0 participants