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

Remove unnecessary "``sh" in CONTRIBUTING.md` #1294

Merged
merged 1 commit into from
Feb 8, 2024

Conversation

nilsreichardt
Copy link
Member

@nilsreichardt nilsreichardt commented Feb 8, 2024

Summary by CodeRabbit

  • Documentation
    • Updated the contributing guidelines by removing an empty code block related to running the app on different platforms.

Copy link
Contributor

coderabbitai bot commented Feb 8, 2024

Walkthrough

This update involves simplifying the documentation by removing an unnecessary code block that was previously intended to guide users on running the application on Android, iOS, and macOS platforms. The removal indicates a streamlined approach, perhaps due to improved automation or the deemed redundancy of the instructions.

Changes

File Change Summary
CONTRIBUTING.md Removed an empty code block for Android, iOS, macOS.

🐰✨
In the docs, a block did lay,
Empty, quiet, in the way.
With a hop, and a skip, we say,
"Clean and tidy wins the day!"
🌟📖

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 8beb894 and b19a4cf.
Files selected for processing (1)
  • CONTRIBUTING.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • CONTRIBUTING.md

@nilsreichardt nilsreichardt added this pull request to the merge queue Feb 8, 2024
Merged via the queue into main with commit 6434fa9 Feb 8, 2024
26 checks passed
@nilsreichardt nilsreichardt deleted the nilsreichardt-patch-1 branch February 8, 2024 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants