Skip to content
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

Update issue templates #4835

Merged
merged 1 commit into from
Nov 13, 2024
Merged

Update issue templates #4835

merged 1 commit into from
Nov 13, 2024

Conversation

vio
Copy link
Member

@vio vio commented Nov 13, 2024

Summary by CodeRabbit

  • New Features
    • Introduced a bug report template to streamline bug reporting with structured sections for detailed information.
    • Added a custom issue template to facilitate the creation of issues with predefined fields.
    • Launched a feature request template to enhance communication of feature ideas and solutions.

Copy link

coderabbitai bot commented Nov 13, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

Three new issue templates have been introduced in the .github/ISSUE_TEMPLATE/ directory. The templates include a bug report template, a custom issue template, and a feature request template. Each template is structured to guide users in providing detailed information relevant to their issues or requests, including sections for descriptions, steps to reproduce, expected behavior, and additional context.

Changes

File Path Change Summary
.github/ISSUE_TEMPLATE/bug_report.md Added a new bug report template with structured sections for detailed bug reporting.
.github/ISSUE_TEMPLATE/custom.md Introduced a new custom issue template with metadata and predefined fields.
.github/ISSUE_TEMPLATE/feature_request.md Created a new feature request template to facilitate communication of feature ideas.

Poem

In the garden of code, new templates bloom,
For bugs and for features, they clear up the gloom.
With fields for the details, so clear and so bright,
Reporting our issues is now a delight! 🐇✨
Let’s hop to it, friends, and share what we find,
With templates like these, we’ll be one of a kind!


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 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.

@vio vio enabled auto-merge November 13, 2024 22:56
Copy link

relativeci bot commented Nov 13, 2024

#11667 Bundle Size — 381.32KiB (0%).

a703db5(current) vs 624676d master#11664(baseline)

Warning

Bundle contains 2 duplicate packages – View duplicate packages

Bundle metrics  no changes
                 Current
#11667
     Baseline
#11664
No change  Initial JS 334.44KiB 334.44KiB
No change  Initial CSS 46.89KiB 46.89KiB
No change  Cache Invalidation 0% 0%
No change  Chunks 3 3
No change  Assets 4 4
No change  Modules 699 699
No change  Duplicate Modules 0 0
No change  Duplicate Code 0% 0%
No change  Packages 39 39
No change  Duplicate Packages 1 1
Bundle size by type  no changes
                 Current
#11667
     Baseline
#11664
No change  JS 334.44KiB 334.44KiB
No change  CSS 46.89KiB 46.89KiB

Bundle analysis reportBranch issue-templatesProject dashboard


Generated by RelativeCIDocumentationReport issue

@vio vio merged commit a649fc4 into master Nov 13, 2024
25 of 26 checks passed
@vio vio deleted the issue-templates branch November 13, 2024 22:59
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.

1 participant