Skip to content

Add 2 issue templates #2

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-for-dev[bot]
Copy link

@gitauto-for-dev gitauto-for-dev bot commented Feb 15, 2025

Why is this feature needed?

To streamline how users report bugs and request new features, we've added two issue templates. These templates help gather consistent and comprehensive information by providing structured forms. This is important for improving issue triaging and ensuring that developers have all the necessary details upfront.

What and how are we changing? Why this approach?

We've added two new YAML files in the .github/ISSUE_TEMPLATE directory:

  • bug_report.yml: Contains a detailed template for bug reports, including fields for bug behavior, logs, screenshots, reproduction steps, expected behavior, and system details.
  • feature_request.yml: Contains a detailed template for feature requests, including fields for the problem description, current workaround, proposed solution, and additional information.

This approach standardizes the issue submission process, making it easier to diagnose problems and understand feature needs quickly. The structured format ensures that contributors provide crucial context, which speeds up turnaround times for fixes and improvements.

What actions are required from users?

Users can now select the appropriate issue template (Bug Report or Feature Request) when opening a new issue on GitHub. No additional configuration is required on the user’s part; simply choose the provided template that best matches your issue.

How does it work? (Technical details)

  • The bug_report.yml template defines multiple form fields of types such as textarea and input. Each field comes with attributes like labels, descriptions, placeholders, and validations to ensure required information is provided.
  • The feature_request.yml template follows a similar format, guiding users to fill in details about the problem, current solutions, and the propose changes.
  • GitHub automatically recognizes .github/ISSUE_TEMPLATE and configures the new issue forms based on these YAML definitions.

Is it backwards compatible?

Yes, adding these templates does not affect any existing repository functionality. They are an enhancement to the issue submission process and are completely backward compatible.

Any other considerations?

  • The template fields have been designed to prompt users for clear, actionable details, which should help maintain high-quality issue reports.
  • We made sure to include validations for required fields to reduce incomplete issue submissions.
  • Future improvements could include additional templates for other issue types if necessary, based on user feedback.

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