Skip to content

Add 2 issue templates#1

Open
gitauto-ai[bot] wants to merge 2 commits intomainfrom
gitauto/add-issue-templates-62782d3e-a4ed-4c25-90e8-1945d8b3665d
Open

Add 2 issue templates#1
gitauto-ai[bot] wants to merge 2 commits intomainfrom
gitauto/add-issue-templates-62782d3e-a4ed-4c25-90e8-1945d8b3665d

Conversation

@gitauto-ai
Copy link

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

Why is this feature needed?

To standardize issue reporting and feature requesting, we've added two new issue templates. These templates aim to streamline the issue creation process by ensuring that contributors provide all necessary information in a consistent format. This will improve communication between users and maintainers, ultimately speeding up troubleshooting and development.

What and how are we changing? Why this approach?

We're adding two new YAML files to the .github/ISSUE_TEMPLATE directory:
• bug_report.yml
• feature_request.yml

Each template includes specific fields and placeholders designed to capture essential details about bugs or feature requests. For bug reports, users are prompted to include information such as the bug behavior, logs, screenshots, steps to reproduce, expected behavior, and system details. For feature requests, the template guides users to describe the problem, their current workaround, and what they propose as a solution, among others.

This approach provides clear guidance to our contributors, ensuring that the issues we receive are well-organized and detailed enough to address them efficiently.

What actions are required from users?

Users need to simply follow the provided templates when opening a new issue. When reporting a bug or suggesting a new feature, the corresponding template will appear automatically, guiding them to supply the necessary information for a prompt review.

How does it work? (Technical details)

  • The issue templates are defined in YAML files and placed within the .github/ISSUE_TEMPLATE directory.
  • GitHub automatically detects these files, presenting them as options when creating a new issue.
  • Each template specifies a unique title prefix (e.g., "Bug: " or "Feature Request: ") to help classify issues, and predefined labels (such as "bug" or "enhancement") are applied to assist in triaging.
  • The structured format ensures that details like logs, steps to reproduce, and environment information are included, which supports more efficient problem identification and resolution.

Is it backwards compatible?

Yes, this change is fully backwards compatible. It adds new files without modifying existing functionality, and the templates will only be used when contributors create new issues.

Any other considerations?

  • These templates are designed to be a starting point; they can be refined over time based on user feedback and evolving project needs.
  • Future enhancements could include adding default assignees or modifying the structure further to capture additional context.
  • Other contributors are welcome to suggest or contribute improvements to these templates to help cater to different types of issues or emerging patterns in our workflow.

@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