Skip to content

Add 2 issue templates #1

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
Contributor

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

Why is this feature needed?

This feature provides standardized issue templates for bug reports and feature requests, which will help maintain consistency in issue reporting, streamline triaging, and ensure that all necessary information is provided upfront. By having dedicated templates, we can improve communication between users and maintainers, leading to quicker diagnosis and resolution of issues.

What and how are we changing? Why this approach?

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

  • bug_report.yml: Defines a bug report template with sections for bug behavior, logs, screenshots, reproduction steps, expected behavior, possible causes, device details, operating system, browser, and additional information.
  • feature_request.yml: Defines a feature request template with fields for describing the problem, current solution, proposed solution, attachments, and additional information.

Using YAML configuration files for issue templates leverages GitHub’s native support, allowing for a structured and consistent data collection process when users report bugs or request new features.

What actions are required from users?

No immediate user action is required, as these templates are integrated directly into the repository’s issue submission process. When users create a new issue, they will be prompted to select the appropriate template (bug report or feature request) and fill in the relevant details based on the guided prompts.

How does it work? (Technical details)

  • The new YAML files are placed in the ".github/ISSUE_TEMPLATE" folder.
  • GitHub automatically detects and lists these templates when users create an issue.
  • Each template file defines a series of fields (using GitHub’s issue template schema) including text areas and input fields with validation rules, labels, and placeholders.
  • This approach standardizes issue reporting by ensuring that critical information like reproduction steps, logs, and system details are captured at the time of issue creation.

Is it backwards compatible?

Yes, this change is fully backwards compatible. It simply adds new configuration files for issue templates without altering any existing functionality in the repository.

Any other considerations?

  • These templates can be further customized according to the project’s evolving needs.
  • Additional fields or modifications can be added based on feedback from both users and maintainers.
  • Future improvements could include adding more guided templates for other types of issues.

@gitauto-ai gitauto-ai bot requested a review from hiroshinishio February 18, 2025 00:42
@gitauto-ai gitauto-ai bot added the gitauto label Feb 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants