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 typo in README.md #29

Merged
merged 1 commit into from
May 10, 2024
Merged

Conversation

NicolasCARPi
Copy link
Contributor

@NicolasCARPi NicolasCARPi commented May 10, 2024

Q A
Bugfix? ✔️
Breaks BC?
New feature?

Cheers :)

Summary by CodeRabbit

  • Documentation
    • Corrected a typo in the README.md to accurately describe the integration capabilities with existing applications.

Copy link

coderabbitai bot commented May 10, 2024

Walkthrough

The update involves a simple yet crucial correction in the project documentation. The README file has been modified to fix a typographical error, changing the word "existed" to "existing" in the section discussing integration with native net/rpc applications. This ensures clarity and accuracy in describing the project's capabilities.

Changes

File Change Summary
README.md Corrected typo: changed "existed" to "existing"

Poem

🐰✨
In the docs of old, a typo stood bold,
Misleading the coders, both young and old.
With a hop and a fix, no more tricks,
Now 'existing' it ticks, in the net/rpc mix.
Cheers to clear words, our understanding unblurred! 🎉
🐰✨


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

@rustatian rustatian self-requested a review May 10, 2024 20:55
@rustatian rustatian added the enhancement New feature or request label May 10, 2024
Copy link
Contributor

@rustatian rustatian left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @NicolasCARPi 👍

@rustatian rustatian merged commit 8fe68b0 into roadrunner-php:4.x May 10, 2024
6 of 7 checks passed
@NicolasCARPi NicolasCARPi deleted the nico-readme branch May 10, 2024 20:56
@NicolasCARPi
Copy link
Contributor Author

Pretty sure we have a PR merge record time here 😮

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Out of diff range and nitpick comments (4)
README.md (4)

Line range hint 17-17: Consider adding an article before "high performance" for grammatical correctness.

- Goridge is high performance PHP-to-Golang codec library
+ Goridge is a high performance PHP-to-Golang codec library

Line range hint 18-18: Ensure all Markdown links are correctly formatted.

- [goridge](https://github.com/roadrunner-server/goridge)
+ [goridge](https://github.com/roadrunner-server/goridge)

Line range hint 40-40: Specify the language for code blocks to enhance readability and syntax highlighting.

- ```php
+ ```php

Line range hint 4-4: Add alternate text to images for accessibility.

- <img align="center" src="https://github.com/roadrunner-server/.github/assets/8040338/040fb694-1dd3-4865-9d29-8e0748c2c8b8">
+ <img align="center" src="https://github.com/roadrunner-server/.github/assets/8040338/040fb694-1dd3-4865-9d29-8e0748c2c8b8" alt="Roadrunner Server Logo">
Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 1652393 and e8ba030.
Files selected for processing (1)
  • README.md (1 hunks)
Additional Context Used
LanguageTool (2)
README.md (2)

Near line 17: You might be missing the article “a” here.
Context: ...ation Award" align="left"/> Goridge is high performance PHP-to-Golang codec library...


Near line 18: Unpaired symbol: ‘]’ seems to be missing
Context: ...e code can be found in this repository: [goridge](https://github.com/roadrunner-s...

Additional comments not posted (1)
README.md (1)

29-29: Corrected typo from "existed" to "existing" enhances clarity.

@rustatian
Copy link
Contributor

Usual case for RoadRunners 😜 😆

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants