Add 2 issue templates

[gitauto-ai[bot]]

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

New Features:

• Introduce issue templates for bug reports and feature requests to streamline the process of creating issues in the repository.

[korbit-ai[bot]]

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[bot]]

Review changes with SemanticDiff.

[senior-dev-bot[bot]]

Hi there! :wave: 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[bot]]

:wave: 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 webber@takken.io.}}

[sourcery-ai[bot]]

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
    section Bug Report
      User: Clicks on 'New Issue' --> 5: User
      User: Selects 'Bug Report' template --> 5: User
      User: Fills out bug details (behavior, logs, screenshots, etc.) --> 5: User
      User: Submits the bug report --> 5: User
    section Feature Request
      User: Clicks on 'New Issue' --> 5: User
      User: Selects 'Feature Request' template --> 5: User
      User: Fills out feature details (problem, current solution, proposed solution, etc.) --> 5: User
      User: Submits the feature request --> 5: User

File-Level Changes

Change	Details	Files
Added a bug report issue 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, possible cause, device details, OS information, browser version, and additional context Added labels 'bug' and 'gitauto' to the template Made most fields required to ensure comprehensive bug reports	.github/ISSUE_TEMPLATE/bug_report.yml
Added a feature request issue template	Created a structured form for submitting feature requests Included fields for describing the problem, current solution, proposed solution, attachments, and additional information Added labels 'enhancement' and 'gitauto' to the template Made key fields required to ensure well-defined feature requests	.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](https://app.sourcery.ai) 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](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).

[instapr[bot]]

Feedback

• Templates added successfully.
• Please ensure consistency in template fields between bug_report.yml and feature_request.yml.
• Review and merge the PR if everything looks good.

[codara-ai-code-review[bot]]

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

1. /github/ISSUE_TEMPLATE/bug_report.yml - The id for the when_it_occurred field might confuse users as it is labeled as "When It Occurred" but doesn’t strictly enforce a timestamp format. Users might enter arbitrary date strings, leading to inconsistencies in reported data.

2. /github/ISSUE_TEMPLATE/bug_report.yml - The screenshots field is described as a textarea but should ideally allow users to upload files or include URLs. As it stands, users may misunderstand this field's functionality, leading to frustration.

3. /github/ISSUE_TEMPLATE/feature_request.yml - The lack of a clear input field for specifying the expected timeline or urgency for the feature request may lead to miscommunication about priority.

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

1. /github/ISSUE_TEMPLATE/bug_report.yml - Consider modifying the when_it_occurred input to enforce a date format using a date picker or a more guided input to ensure consistent data entry, such as accepting ISO 8601 formatted dates.

2. /github/ISSUE_TEMPLATE/bug_report.yml - Change the screenshots textarea type to a file input type if your template supports file uploads, or clarify in the documentation how users can submit these as URLs instead of text.

3. /github/ISSUE_TEMPLATE/feature_request.yml - Include an additional input field (e.g., dropdown or text area) for users to indicate the urgency or impact level of the feature request to prioritize submissions, ensuring clarity on which features are critical.

4. /github/ISSUE_TEMPLATE/bug_report.yml - Ensure the descriptions in placeholders provide clear formatting guidance, and consider adding character count limits on textareas to avoid overly verbose entries that make reviews cumbersome.

5. /github/ISSUE_TEMPLATE/feature_request.yml - Standardize the label format for all required fields across both templates. For instance, use the same styling for placeholder texts (e.g., "Please describe...") to maintain consistency and improve user experience.

[gooroo-dev[bot]]

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 share your feedback with me!

[gstraccini[bot]]

This pull request is ready ✅ for merge/squash.