Add 2 issue templates

[gitauto-ai]

Overview

This PR adds issue templates to the repository so that you can create issues more easily for GitAuto and your project. Please review the changes and merge the PR if you agree.

Added templates:

• bug_report.yml
• feature_request.yml

Summary by Sourcery

Add issue templates for bug reports and feature requests to improve the process of creating and managing issues in the repository.

New Features:

• Introduce a bug report issue template to streamline the process of reporting bugs with detailed information such as bug behavior, logs, steps to reproduce, and more.
• Add a feature request issue template to facilitate the submission of new feature ideas, including problem description, current solutions, and proposed solutions.

[korbit-ai]

By default, I don't review pull requests opened by bots. If you would like me to review this pull request anyway, you can request a review via the /korbit-review command in a comment.

[semanticdiff-com]

Review changes with SemanticDiff.

[gooroo-dev]

Please double check the following review of the pull request:

Issues counts

🐞Mistake	🤪Typo	🚨Security	🚀Performance	💪Best Practices	📖Readability	❓Others
0	0	0	0	0	0	0

Changes in the diff

• ➕ Added a bug report issue template in YAML format.
• ➕ Added a feature request issue template in YAML format.

Identified Issues

ID	Type	Details	Severity	Confidence
1	💪Best Practices	Missing assignees in the issue templates	🟡Low	🟡Low

Issue Explanations and Fixes

1. Missing assignees in the issue templates

Explanation:
The issue templates for bug reports and feature requests do not have default assignees specified. While this is not a critical issue, it is considered a best practice to assign issues to relevant team members automatically to ensure they are addressed promptly.

File Path and Lines:

• .github/ISSUE_TEMPLATE/bug_report.yml at line 5
• .github/ISSUE_TEMPLATE/feature_request.yml at line 5

Code Fix:

# For bug_report.yml
assignees: ["defaultAssignee"]

# For feature_request.yml
assignees: ["defaultAssignee"]

Explanation of the Fix:
Adding a default assignee ensures that issues are automatically assigned to a responsible team member. This can help in streamlining the process of issue resolution and ensures accountability.

Missing Tests for the Incoming Changes

Since the changes involve adding issue templates, there are no direct code tests required. However, it is important to verify that the templates function as expected when creating new issues on the repository. This can be done by manually creating test issues using the templates to ensure all fields are present and correctly formatted.

Summon me to re-review when updated! Yours, Gooroo.dev
React or reply to keep the conversation going!

[senior-dev-bot]

Hi there! 👋 Thanks for opening a PR. It looks like you've already reached the 5 review limit on our Basic Plan for the week. If you still want a review, feel free to upgrade your subscription in the Web App and then reopen the PR

[pr-code-reviewer]

👋 Hi there!

Everything looks good!

_{^{Automatically generated with the help of gpt-3.5-turbo.
Feedback? Please don't hesitate to drop me an email at [email protected].}}

[instapr]

Feedback

• The bug report template looks comprehensive and well-structured. Good job on providing clear instructions and placeholders for each section.

• The feature request template is also well-defined with detailed information fields. Nicely done in capturing essential details for the proposed feature.

Both templates are clear and well-designed. The PR is good to merge.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request adds two issue templates to the repository: one for bug reports and another for feature requests. The templates are implemented as YAML files in the .github/ISSUE_TEMPLATE directory, providing structured forms for users to submit detailed bug reports and feature requests.

User journey diagram for new issue templates

journey
    title User journey for creating issues with new templates
    section Bug Report
      User selects "Bug Report" template: 5: User
      User fills out bug details: 4: User
      User submits bug report: 3: User
    section Feature Request
      User selects "Feature Request" template: 5: User
      User fills out feature request details: 4: User
      User submits feature request: 3: User

Loading

File-Level Changes

Change	Details	Files
Added a comprehensive bug report template	Implemented a structured form with various fields for detailed bug reporting Included fields for bug behavior, logs, screenshots, occurrence time, reproduction steps, expected behavior, and possible cause Added system information fields such as device, OS, and browser Provided clear instructions and examples for each field	.github/ISSUE_TEMPLATE/bug_report.yml
Added a feature request template	Created a structured form for submitting feature requests Included fields for describing the problem, current solution, and proposed solution Added optional fields for screenshots/diagrams and additional information	.github/ISSUE_TEMPLATE/feature_request.yml
Configured metadata for both templates	Set appropriate titles, descriptions, and labels for each template Prepared assignee field (commented out) for future use	.github/ISSUE_TEMPLATE/bug_report.yml .github/ISSUE_TEMPLATE/feature_request.yml

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[codara-ai-code-review]

Potential issues, bugs, and flaws that can introduce unwanted behavior.

1. .github/ISSUE_TEMPLATE/bug_report.yml - The template is very detailed but may overwhelm users. It's essential to ensure that all questions guide the users effectively without causing frustration. Consider prioritizing the most critical questions or making it clearer which fields are essential versus which are optional.

2. .github/ISSUE_TEMPLATE/feature_request.yml - Similar to the bug report, the template lacks clarity on the necessity of fields. While most fields are marked required, it may still benefit from explicit instructions regarding the impact of missing details and how it affects the processing of their requests.

Code suggestions and improvements for better exception handling, logic, standardization, and consistency (without impeding code quality).

1. .github/ISSUE_TEMPLATE/bug_report.yml: In id: when_it_occurred, consider adding a more specific format requirement for the date string to reduce ambiguity. For instance, explicitly request a certain date format (like ISO 8601) to avoid confusion.

2. .github/ISSUE_TEMPLATE/feature_request.yml: In id: current_solution, it might be helpful to add a note informing users that this section is optional and to elaborate on why they may identify their current solution, improving the context of the request.

3. .github/ISSUE_TEMPLATE/bug_report.yml & .github/ISSUE_TEMPLATE/feature_request.yml: Consistency could be improved by aligning the naming conventions of input and textarea fields. For example, in the bug report, device is an input while problem and others are textareas. Ensure that similar types of data are consistently captured in a similar input type (like a textarea for longer descriptions).

4. .github/ISSUE_TEMPLATE/bug_report.yml: In sections like id: possible_cause, an optional field could list common causes to prompt users, helping them generate suggestions more easily while improving the quality of information received.

5. .github/ISSUE_TEMPLATE/feature_request.yml: The placeholders in the fields can be enhanced by adding examples that stay consistent with user expectations. For example, the "Proposed Solution" field can include a better template to ensure users provide actionable details relevant to implementation.

[sourcery-ai]

We have skipped reviewing this pull request. It seems to have been created by a bot (hey, gitauto-ai[bot]!). We assume it knows what it's doing!

[github-actions]

Infisical secrets check: ✅ No secrets leaked!

💻 Scan logs

9:59AM INF scanning for exposed secrets...
9:59AM INF 3 commits scanned.
9:59AM INF scan completed in 63.9ms
9:59AM INF no leaks found