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 --evm-enabled flag in README.md instructions #568

Merged
merged 2 commits into from
Sep 23, 2024
Merged

Conversation

jribbink
Copy link
Contributor

@jribbink jribbink commented Sep 23, 2024

Description

The --evm-enabled flag has been removed from the flow emulator


For contributor use:

  • Targeted PR against master branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the standards mentioned here.
  • Updated relevant documentation
  • Re-reviewed Files changed in the Github PR explorer
  • Added appropriate labels

Summary by CodeRabbit

  • Documentation
    • Updated instructions for running the EVM Gateway locally, simplifying the command to start the emulator.

@jribbink jribbink added the Documentation Improvements or additions to documentation label Sep 23, 2024
Copy link
Contributor

coderabbitai bot commented Sep 23, 2024

Walkthrough

The changes involve an update to the README.md file, specifically modifying the instructions for running the EVM Gateway locally. The command to start the emulator has been simplified from flow emulator --evm-enabled to flow emulator, indicating a potential change in default settings or a streamlined command. The instruction regarding the flow.json configuration remains unchanged.

Changes

File Change Summary
README.md Updated instructions for running the EVM Gateway locally; simplified command from flow emulator --evm-enabled to flow emulator.

Poem

In the meadow where bunnies play,
A command was changed, hip-hip-hooray!
From long to short, it hops with glee,
EVM now runs so easily!
With joy we cheer, our work is done,
Let's start the emulator, and have some fun! 🐇✨


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.

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.

Actionable comments posted: 0

Outside diff range and nitpick comments (1)
README.md (1)

45-47: Approve the removal of --evm-enabled flag and suggest minor improvements

The removal of the --evm-enabled flag from the Flow Emulator command is correct and aligns with the PR objective. This simplifies the instructions for users.

However, there are two minor improvements we can make:

  1. Add a comma after "locally" on line 45 for better readability.
  2. Specify the language for the fenced code block on line 47.

Here's the suggested change:

-To run the gateway locally you need to start the Flow Emulator:
-```
+To run the gateway locally, you need to start the Flow Emulator:
+```bash
 flow emulator

<details>
<summary>Tools</summary>

<details>
<summary>LanguageTool</summary><blockquote>

[uncategorized] ~45-~45: Possible missing comma found.
Context: ... **Start Emulator**  To run the gateway locally you need to start the Flow Emulator: ``...

(AI_HYDRA_LEO_MISSING_COMMA)

</blockquote></details>
<details>
<summary>Markdownlint</summary><blockquote>

46-46: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

</blockquote></details>

</details>

</blockquote></details>

</blockquote></details>

<details>
<summary>Review details</summary>

**Configuration used: CodeRabbit UI**
**Review profile: CHILL**

<details>
<summary>Commits</summary>

Files that changed from the base of the PR and between d57cf9ffa126de1c551fe074afc2b6fdd20ef263 and 8af6a2f5aab56f9b120c4afc9fd1164afd3cba12.

</details>


<details>
<summary>Files selected for processing (1)</summary>

* README.md (1 hunks)

</details>












<details>
<summary>Additional context used</summary>

<details>
<summary>LanguageTool</summary><blockquote>

<details>
<summary>README.md</summary><blockquote>

[uncategorized] ~45-~45: Possible missing comma found.
Context: ... **Start Emulator**  To run the gateway locally you need to start the Flow Emulator: ``...

(AI_HYDRA_LEO_MISSING_COMMA)

</blockquote></details>

</blockquote></details>
<details>
<summary>Markdownlint</summary><blockquote>

<details>
<summary>README.md</summary><blockquote>

46-46: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

</blockquote></details>

</blockquote></details>

</details>


</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

Copy link
Collaborator

@m-Peter m-Peter left a comment

Choose a reason for hiding this comment

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

Nice catch 🙏

@m-Peter m-Peter merged commit 888c69d into main Sep 23, 2024
2 checks passed
@m-Peter m-Peter deleted the jribbink-patch-1 branch September 23, 2024 15:54
@coderabbitai coderabbitai bot mentioned this pull request Oct 17, 2024
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants