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

fixed typo in developers guide section #525

Conversation

ChandraShekharAgrawal
Copy link
Contributor

@ChandraShekharAgrawal ChandraShekharAgrawal commented Jan 5, 2025

What kind of change does this PR introduce?

This is a small typo fix.

Why was this change needed?

It was a spell mistake, so I wanted to improve it.

Other information:

NA

Checklist:

Put a "X" in the boxes below to indicate you have followed the checklist;

  • I have read the CONTRIBUTING guide.
  • I checked that there were not similar issues or PRs already open for this.
  • This PR fixes just ONE issue (do not include multiple issues or types of change in the same PR) For example, don't try and fix a UI issue and include new dependencies in the same PR.

Summary by CodeRabbit

  • Documentation
    • Fixed a minor typographical error in the CONTRIBUTING.md document to improve readability.

Copy link

vercel bot commented Jan 5, 2025

@ChandraShekharAgrawal is attempting to deploy a commit to the Listinai Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

coderabbitai bot commented Jan 5, 2025

Walkthrough

The pull request involves a minor typographical correction in the CONTRIBUTING.md file. A simple spelling error was fixed, changing "Read t his document" to "Read this document" by removing an unintended space between "t" and "his". This is a purely editorial change that does not impact the document's functionality or meaning.

Changes

File Change Summary
CONTRIBUTING.md Corrected typographical error in text

Possibly related PRs

  • feat: Fix typo #509: Another PR involving a grammatical correction, suggesting a shared focus on improving documentation text clarity

Poem

🐰 A Rabbit's Typo Tale

With a hop and a twitch of my ear,
I spotted a space that shouldn't be here!
"Read t his" was wrong, oh what a sight,
A quick fix makes the document bright!
Precision matters, even in small ways 🔍


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.

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

🧹 Nitpick comments (1)
CONTRIBUTING.md (1)

7-7: Fix grammatical issue: "setup" should be "set up" when used as a verb

The sentence reads well, but there's a minor grammatical issue. When used as a verb, "setup" should be written as two words: "set up".

-The main documentation site has a [developer guide](https://docs.postiz.com/developer-guide) . That guide provides you a good understanding of the project structure, and how to setup your development environment. Read this document after you have read that guide. This document is intended to provide you a good understanding of how to submit your first contribution.
+The main documentation site has a [developer guide](https://docs.postiz.com/developer-guide) . That guide provides you a good understanding of the project structure, and how to set up your development environment. Read this document after you have read that guide. This document is intended to provide you a good understanding of how to submit your first contribution.
🧰 Tools
🪛 LanguageTool

[grammar] ~7-~7: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...ng of the project structure, and how to setup your development environment. Read this...

(NOUN_VERB_CONFUSION)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f4a4d8a and 788b9b5.

📒 Files selected for processing (1)
  • CONTRIBUTING.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md

[grammar] ~7-~7: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...ng of the project structure, and how to setup your development environment. Read this...

(NOUN_VERB_CONFUSION)

@jamesread jamesread merged commit 82bef1f into gitroomhq:main Jan 6, 2025
1 of 3 checks passed
@jamesread
Copy link
Collaborator

Many thanks @ChandraShekharAgrawal ! :-)

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.

2 participants