Update README.md #178
Update README.md #178
Conversation
WalkthroughThe changes focus on updating software versions to CosmWasm v0.51.x, removing vote extensions from cosmos-sdk and cometbft versions, and eliminating the mention of Packet Forward Middleware. The emphasis is on maintaining modules and middleware for system efficiency and compatibility with evolving standards. Changes
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
There was a problem hiding this comment.
Review Status
Actionable comments generated: 4
Configuration used: CodeRabbit UI
Files selected for processing (1)
- README.md (1 hunks)
Additional comments: 1
README.md (1)
- 8-19: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [70-70]
The repetition of "code == docs" and "docs == logo" seems to be a typo or an oversight. Consider revising for clarity and to avoid redundancy.
Consider revising the contribution guidelines to avoid redundancy and provide clear distinctions between different types of contributions.
README.md
Outdated
|
|
||
| ## Software at launch | ||
|
|
||
| Note: it is possible that we fall back to v0.47.x if simply avoiding vote extensions proves to be ineffective in stopping the issues seen in deployments of comet v0.38.x | ||
|
|
||
| * cosmos-sdk v0.50.x without vote extensions | ||
| * cometbft v0.38.x without vote extensions | ||
| * CosmWasm v0.50.x | ||
| * cosmos-sdk v0.50.x | ||
| * cometbft v0.38.x | ||
| * CosmWasm v0.51.x | ||
| * WasmVM v2.0.x | ||
| * IBC-go v8.1.x | ||
| * Token Factory | ||
| * Packet Forward Middleware | ||
| * IBC Hooks | ||
|
|
||
| this also means fhat Eve, as loving mother and repeatable template, is committed to ensuring that the modules amd middlewares above are kept up to date rigorously, with up to date being defined as supporting the latest release of cosmos-sdk, **regardless of the decisions of other teams**. Eve is very confident in the current cosmos-sdk and ibc-go maintenance teams and smiles warmly at them. |
There was a problem hiding this comment.
📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [41-41]
There's a spelling mistake in "produciton" which should be corrected to maintain professionalism in the documentation.
- Quicksilver and affiliated teams plan to use eve to put the newest SDK, IBC and WASMD into produciton quickly.
+ Quicksilver and affiliated teams plan to use eve to put the newest SDK, IBC, and WASMD into production quickly.📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [47-47]
There's a spelling mistake in "becasue" which should be corrected. Additionally, consider rephrasing for clarity.
- Eve won't use her community pool to compete with your contracts, becasue eve does not have a community pool.
+ Eve won't use a community pool to compete with your contracts, because Eve does not have a community pool.There was a problem hiding this comment.
we refer to eve as a female, like a pirate talking about their ship.
There was a problem hiding this comment.
@faddat, thank you for clarifying the narrative style of referring to "eve" as a female in the documentation. I'll keep this in mind for future reviews to ensure that my suggestions align with your project's stylistic choices.
New Learnings Added
User: faddat
PR: eve-network/eve#178
File: README.md:8-19
Timestamp: 2024-03-23T21:26:19.771Z
Learning: In the eve-network/eve project documentation, "eve" is personified and referred to as a female. This stylistic choice should be respected in all interactions and suggestions related to the project's documentation.
Note: Learnings are effective only in the context of specific code segments. To apply general coding guidelines, please configure path-based instructions.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
| * cosmos-sdk v0.50.x | ||
| * cometbft v0.38.x | ||
| * CosmWasm v0.51.x |
There was a problem hiding this comment.
The software version updates are accurately reflected, aligning with the PR objectives. However, there are minor typographical errors and inconsistencies in the formatting of the software list that could be improved for better readability.
* cosmos-sdk v0.50.x
* cometbft v0.38.x
- * CosmWasm v0.51.x
- * WasmVM v2.0.x
- * IBC-go v8.1.x
- * Token Factory
- * IBC Hooks
+ * CosmWasm v0.51.x
+ * WasmVM v2.0.x
+ * IBC-go v8.1.x
+ * Token Factory
+ * IBC HooksEnsure consistent capitalization and spacing for list items to enhance readability.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * cosmos-sdk v0.50.x | |
| * cometbft v0.38.x | |
| * CosmWasm v0.51.x | |
| * cosmos-sdk v0.50.x | |
| * cometbft v0.38.x | |
| * CosmWasm v0.51.x | |
| * WasmVM v2.0.x | |
| * IBC-go v8.1.x | |
| * Token Factory | |
| * IBC Hooks |
| * IBC Hooks | ||
|
|
||
| this also means fhat Eve, as loving mother and repeatable template, is committed to ensuring that the modules amd middlewares above are kept up to date rigorously, with up to date being defined as supporting the latest release of cosmos-sdk, **regardless of the decisions of other teams**. Eve is very confident in the current cosmos-sdk and ibc-go maintenance teams and smiles warmly at them. | ||
| This also means that Eve, as a loving mother and repeatable template, is committed to ensuring that the modules and middlewares above are kept up to date rigorously, with "up to date" being defined as supporting the latest release of cosmos-sdk, **regardless of the decisions of other teams**. Eve is very confident in the current cosmos-sdk and ibc-go maintenance teams and smiles warmly at them. |
There was a problem hiding this comment.
The affirmation regarding module and middleware maintenance is clear and aligns with the PR objectives. However, there are grammatical issues and a spelling mistake that need correction.
- This also means that Eve, as a loving mother and repeatable template, is committed to ensuring that the modules and middlewares above are kept up to date rigorously, with "up to date" being defined as supporting the latest release of cosmos-sdk, **regardless of the decisions of other teams**. Eve is very confident in the current cosmos-sdk and ibc-go maintenance teams and smiles warmly at them.
+ This also means that Eve, as a loving mother and repeatable template, is committed to ensuring that the modules and middlewares above are kept up to date rigorously, with "up to date" being defined as supporting the latest release of cosmos-sdk, **regardless of the decisions of other teams**. Eve is very confident in the current cosmos-sdk and ibc-go maintenance teams and smiles warmly at them.Correct the grammatical issues and remove the extra space before "Eve is very confident..." for consistency.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| This also means that Eve, as a loving mother and repeatable template, is committed to ensuring that the modules and middlewares above are kept up to date rigorously, with "up to date" being defined as supporting the latest release of cosmos-sdk, **regardless of the decisions of other teams**. Eve is very confident in the current cosmos-sdk and ibc-go maintenance teams and smiles warmly at them. | |
| This also means that Eve, as a loving mother and repeatable template, is committed to ensuring that the modules and middlewares above are kept up to date rigorously, with "up to date" being defined as supporting the latest release of cosmos-sdk, **regardless of the decisions of other teams**. Eve is very confident in the current cosmos-sdk and ibc-go maintenance teams and smiles warmly at them. |
|
|
||
| ## Software at launch | ||
|
|
||
| Note: it is possible that we fall back to v0.47.x if simply avoiding vote extensions proves to be ineffective in stopping the issues seen in deployments of comet v0.38.x | ||
|
|
||
| * cosmos-sdk v0.50.x without vote extensions | ||
| * cometbft v0.38.x without vote extensions | ||
| * CosmWasm v0.50.x | ||
| * cosmos-sdk v0.50.x | ||
| * cometbft v0.38.x | ||
| * CosmWasm v0.51.x | ||
| * WasmVM v2.0.x | ||
| * IBC-go v8.1.x | ||
| * Token Factory | ||
| * Packet Forward Middleware | ||
| * IBC Hooks | ||
|
|
||
| this also means fhat Eve, as loving mother and repeatable template, is committed to ensuring that the modules amd middlewares above are kept up to date rigorously, with up to date being defined as supporting the latest release of cosmos-sdk, **regardless of the decisions of other teams**. Eve is very confident in the current cosmos-sdk and ibc-go maintenance teams and smiles warmly at them. | ||
| This also means that Eve, as a loving mother and repeatable template, is committed to ensuring that the modules and middlewares above are kept up to date rigorously, with "up to date" being defined as supporting the latest release of cosmos-sdk, **regardless of the decisions of other teams**. Eve is very confident in the current cosmos-sdk and ibc-go maintenance teams and smiles warmly at them. | ||
|
|
||
|
|
||
| ## Planned software | ||
|
|
There was a problem hiding this comment.
📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [42-42]
There's a spelling mistake in "produciton" which should be corrected to maintain professionalism in the documentation.
- Quicksilver and affiliated teams plan to use eve to put the newest SDK, IBC and WASMD into produciton quickly.
+ Quicksilver and affiliated teams plan to use eve to put the newest SDK, IBC, and WASMD into production quickly.Correct the spelling of "production" and add a comma after "IBC" for grammatical correctness.
📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [48-48]
There's a spelling mistake in "becasue" which should be corrected. Additionally, consider rephrasing for clarity.
- Eve won't use her community pool to compete with your contracts, becasue eve does not have a community pool.
+ Eve won't use her community pool to compete with your contracts, because Eve does not have a community pool.Correct the spelling of "because" and capitalize "Eve" for consistency.
Summary by CodeRabbit