Skip to content
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

Add 2 issue templates #1

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 Feb 13, 2025

Why is this feature needed?

The repository lacked standardized issue templates for both bug reports and feature requests, which often leads to inconsistent reporting and makes it harder for maintainers to process issues efficiently. By adding these templates, we ensure that contributors provide all the necessary details, which can significantly improve issue triaging and resolution.

What and how are we changing? Why this approach?

This PR adds two new YAML files under the .github/ISSUE_TEMPLATE directory:

  • bug_report.yml: A template for creating detailed bug reports.
  • feature_request.yml: A template to help users describe their feature requests clearly.

These templates standardize the information captured when a new issue is reported, prompting users to include relevant details such as reproduction steps, logs, and device specifics for bugs, and the current solution along with proposed improvements for feature requests. The approach helps maintain a uniform structure, enabling easier filtering, search, and prioritization of issues.

What actions are required from users?

No user action is required after this change is merged. However, contributors will now see these templates when they open a new issue, which encourages them to provide detailed and structured input.

How does it work? (Technical details)

  • The bug_report.yml file defines a detailed structure for bug reporting, including fields for bug behavior, logs, screenshots, reproduction steps, expected behavior, and contextual information like the device, OS, and browser.
  • The feature_request.yml file provides a framework for submitting feature requests with sections for describing the problem, current workaround, proposed solution, and additional context.
  • Both templates are implemented in YAML format as recommended by GitHub, ensuring that the new issues follow the predefined format automatically when the contributor opens a new issue in the repository.

Is it backwards compatible?

Yes, this change is fully backwards compatible. The addition of issue templates does not impact any existing functionalities, and they are only triggered when new issues are created.

Any other considerations?

  • The labels supplied (e.g., "bug", "enhancement", "gitauto") help in quickly categorizing issues.
  • The templates include optional fields for screenshots and additional information, offering flexibility to users.
  • Future improvements may include expanding or customizing these templates based on feedback from contributors.

Feel free to share any feedback for further improvements!


@gitauto-ai gitauto-ai bot requested a review from hiroshinishio February 13, 2025 22:22
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