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

fix(cli): typo desc to scope in scope related rules #362

Merged
merged 1 commit into from
Oct 8, 2024

Conversation

KeisukeYamashita
Copy link
Owner

@KeisukeYamashita KeisukeYamashita commented Oct 8, 2024

Why

Typo... this makes the user confusing because it emits errors like it has problems on description but in reality, it's on the scope.

Summary by CodeRabbit

  • Bug Fixes
    • Improved error messaging in validation process for better clarity when no scope is found.

@KeisukeYamashita KeisukeYamashita self-assigned this Oct 8, 2024
Copy link

coderabbitai bot commented Oct 8, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes involve a modification to the error message in the validate method of the ScopeFormat struct located in src/rule/scope_format.rs. The error message has been updated from "found no description" to "found no scope" to enhance clarity regarding the absence detected in the message.scope field. The overall functionality of the ScopeFormat implementation remains unchanged.

Changes

File Change Summary
src/rule/scope_format.rs Updated error message in validate method from "found no description" to "found no scope".

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ScopeFormat
    User->>ScopeFormat: Validate scope
    ScopeFormat-->>User: Return error message "found no scope"
Loading

🐇 In the code where the scopes play,
A message changed, brightening the way.
From "no description" to "no scope,"
Clarity now, a leap of hope!
In the fields where errors roam,
Clearer words guide us home. 🌼


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.

@KeisukeYamashita KeisukeYamashita merged commit 8a92599 into main Oct 8, 2024
11 of 13 checks passed
@KeisukeYamashita KeisukeYamashita deleted the fix-typo-scope-format branch October 8, 2024 12:55
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