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

Update README.md #1190

Merged
merged 1 commit into from
Feb 27, 2024
Merged

Update README.md #1190

merged 1 commit into from
Feb 27, 2024

Conversation

0xicingdeath
Copy link

@0xicingdeath 0xicingdeath commented Feb 27, 2024

Summary by CodeRabbit

  • Documentation
    • Added a reference to the Curvance project in the smart contracts section.

Copy link

coderabbitai bot commented Feb 27, 2024

Walkthrough

The update introduces a link to the Curvance project in the README, enhancing the documentation by showcasing practical applications of Echidna in smart contracts testing. This change aims to provide users with real-world examples of Echidna's capabilities, enriching the resourcefulness of the documentation.

Changes

File Changed Summary of Changes
README.md Added a link to the Curvance project under the list of smart contracts projects using Echidna for testing.

Related issues

  • crytic/echidna#1130: While this PR does not directly address the restructuring or content modification outlined in the issue, it contributes to the documentation's resourcefulness, which aligns with the broader goal of enhancing usability and clarity for users. This link addition can be seen as complementary to the objectives of decluttering and reorganizing the README for better user guidance.

Poem

In the garden of code, where the smart contracts grow,
A rabbit hopped in, with a link in tow.
"To Curvance," it said, "let this path show,
Where Echidna tests, and the best practices flow."
🐇💻🔗🌱
With each hop and leap, knowledge did sow,
In README's fields, where the curious go.

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.

@arcz arcz merged commit e72975c into master Feb 27, 2024
9 checks passed
@arcz arcz deleted the readme/added-curvance-suite branch February 27, 2024 15:38
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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 92f30c6 and 0b7f8fb.
Files selected for processing (1)
  • README.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • README.md

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