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
Contributor

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

Why is this feature needed?

To streamline issue submission, we are introducing two new issue templates for Bug Reports and Feature Requests. These templates help contributors provide all the necessary information in a structured manner, ensuring that we can diagnose and address issues or consider feature improvements efficiently.

What and how are we changing? Why this approach?

Two YAML template files have been added under the .github/ISSUE_TEMPLATE directory:

  • bug_report.yml: This template guides users to include detailed information such as bug behavior, logs, reproduction steps, expected behavior, and additional context.
  • feature_request.yml: This template ensures users describe the problem, explain their current workaround, propose a desired solution, and share any attachments that could clarify their request.

Using YAML to define these templates provides a consistent, dynamic, and easily maintainable way to collect issue-specific data, which improves the overall quality and triage speed of submitted issues.

What actions are required from users?

  • Users should now select the appropriate issue template (Bug Report or Feature Request) when submitting an issue.
  • They need to follow the provided guidelines in each template to ensure all critical information is included.

How does it work? (Technical details)

  • The bug_report.yml template includes fields such as bug behavior, logs, screenshots, steps to reproduce, and more, with each field carrying validations (e.g., required fields) to ensure completeness.
  • The feature_request.yml template collects necessary data on the problem, current solution, proposed solution, and any helpful attachments.
  • GitHub automatically detects YAML templates in the .github/ISSUE_TEMPLATE directory, enabling these options as soon as a new issue is created.

Is it backwards compatible?

Yes, adding these issue templates is fully backwards compatible. Existing issues and workflows will remain unaffected. These templates will simply augment the process for new issue submissions.

Any other considerations?

  • Future improvements could include refining the validations or adding more templates to serve additional use cases.
  • We considered allowing optional fields for more flexibility; however, the current approach ensures a baseline level of detail, which is critical for effective issue resolution.
  • Feedback from contributors on the usability of these templates is welcome, so we can iterate and improve them over time.

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