Skip to content

Add 2 issue templates#3

Open
gitauto-ai[bot] wants to merge 2 commits into
mainfrom
gitauto/add-issue-templates-8c6f735a-3b10-41a3-a6ad-2402adbf7781
Open

Add 2 issue templates#3
gitauto-ai[bot] wants to merge 2 commits into
mainfrom
gitauto/add-issue-templates-8c6f735a-3b10-41a3-a6ad-2402adbf7781

Conversation

@gitauto-ai

@gitauto-ai gitauto-ai Bot commented Jan 14, 2025

Copy link
Copy Markdown

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:

  • Added issue templates for bug reports and feature requests.

@gitauto-ai
gitauto-ai Bot requested a review from AahPlexX January 14, 2025 04:30
@sourcery-ai

sourcery-ai Bot commented Jan 14, 2025

Copy link
Copy Markdown

Reviewer's Guide by Sourcery

This pull request introduces two new issue templates: a bug report template and a feature request template. These templates are designed to streamline the process of creating issues by providing predefined fields and formatting.

Flow diagram of issue template structure

flowchart TD
    A[Issue Templates] --> B[Bug Report]
    A --> C[Feature Request]

    B --> D[Required Fields]
    B --> E[Optional Fields]

    D --> D1[Bug Behavior]
    D --> D2[Logs]
    D --> D3[When It Occurred]
    D --> D4[Steps to Reproduce]
    D --> D5[Expected Behavior]
    D --> D6[Device Info]
    D --> D7[OS Info]
    D --> D8[Browser Info]

    E --> E1[Screenshots]
    E --> E2[Possible Cause]
    E --> E3[Additional Information]

    C --> F[Required Fields]
    C --> G[Optional Fields]

    F --> F1[Problem Description]
    F --> F2[Current Solution]
    F --> F3[Proposed Solution]

    G --> G1[Screenshots/Diagrams]
    G --> G2[Additional Information]
Loading

File-Level Changes

Change Details Files
Added a bug report template to guide users in reporting bugs effectively.
  • Included fields for bug behavior, logs, screenshots, occurrence time, steps to reproduce, expected behavior, possible cause, device, OS, browser, and additional information.
.github/ISSUE_TEMPLATE/bug_report.yml
Added a feature request template to help users suggest new features.
  • Included fields for problem description, current solution, proposed solution, attachments, and additional information.
.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

@coderabbitai

coderabbitai Bot commented Jan 14, 2025

Copy link
Copy Markdown

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

@gitauto-ai gitauto-ai Bot added the gitauto label Jan 30, 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