plane icon indicating copy to clipboard operation
plane copied to clipboard

fix: Remove typo from Contributing doc

Open ach5948 opened this issue 1 year ago β€’ 2 comments

It looks like there was an accidental paste in CONTRIBUTING.md

Summary by CodeRabbit

  • Documentation
    • Minor textual corrections and clarifications in the CONTRIBUTING.md file.
    • Enhanced guidance on submitting issues, emphasizing the need for minimal reproduction scenarios and relevant details.

ach5948 avatar Oct 01 '24 16:10 ach5948

CLA assistant check
All committers have signed the CLA.

CLAassistant avatar Oct 01 '24 16:10 CLAassistant

Walkthrough

The changes made to the CONTRIBUTING.md file involve minor textual corrections and clarifications. A misspelled word was corrected, and the section regarding issue submissions was rephrased to highlight the importance of providing a minimal reproduction scenario along with relevant details. The overall structure and content of the document remain unchanged, with no modifications to the contribution process.

Changes

File Change Summary
CONTRIBUTING.md Corrected "informplaneation" to "information"; rephrased issue submission section to emphasize minimal reproduction scenarios.

Poem

In the garden of code, where bunnies play,
A word was fixed, brightening the day.
With clear instructions for all to see,
Together we hop, in harmony! πŸ‡βœ¨
So bring your bugs, let’s squash them right,
With clarity and joy, we’ll code through the night!


πŸ“œ Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL

πŸ“₯ Commits

Files that changed from the base of the PR and between 62c45f3bb15b54892bc288db0224e6530aa4dd45 and 9a9415d67f58b12409bc3804edfe156b422a5cf0.

πŸ“’ Files selected for processing (1)
  • CONTRIBUTING.md (1 hunks)
🧰 Additional context used
πŸͺ› LanguageTool
CONTRIBUTING.md

[style] ~7-~7: Consider using a more formal verb to strengthen your wording. Context: ... you of workarounds. Otherwise, you can give new information. While we want to fix ...

(GIVE_INFORMATION)


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.

coderabbitai[bot] avatar Oct 01 '24 16:10 coderabbitai[bot]