-
Notifications
You must be signed in to change notification settings - Fork 34
chore: README changes #377
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
Conversation
WalkthroughThe changes update the README documentation by removing a step that instructed users to fetch the latest denomination configuration. As a result, the subsequent steps were renumbered (with the former step 4 now becoming step 3). Additionally, the copyright notice was updated to reflect the period from 2021 to 2025, replacing the previous 2021–2022 range. The overall structure of the document remains unchanged. Changes
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 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 using PR comments)
Other keywords and placeholders
Documentation and Community
|
There was a problem hiding this 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 (2)
README.md (2)
68-71
: Step Renumbering and Fenced Code Block Language
The updated step numbering is clear and reflects the removal of the denomination configuration step correctly. However, the fenced code block for the unit test command (lines 70–71) does not specify a language. For consistency and improved tooling support (as highlighted by markdownlint), please add a language identifier—for example, change the opening fence from "" to "
bash".🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
69-69: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
75-75
: Typographical Improvement for Date Range
The updated copyright notice now spans the intended years. For better typographical accuracy, consider replacing the hyphen with an en dash (–) in "2021 - 2025".🧰 Tools
🪛 LanguageTool
[typographical] ~75-~75: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...est -v ``` ## License Copyright © 2021 - 2025 Injective Labs Inc. (https://inject...(DASH_RULE)
🪛 markdownlint-cli2 (0.17.2)
75-75: Bare URL used
null(MD034, no-bare-urls)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md
(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[typographical] ~75-~75: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...est -v ``` ## License Copyright © 2021 - 2025 Injective Labs Inc. (https://inject...
(DASH_RULE)
🪛 markdownlint-cli2 (0.17.2)
README.md
69-69: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
75-75: Bare URL used
null
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: run-tests (3.11, windows-latest)
- GitHub Check: run-tests (3.9, windows-latest)
Summary by CodeRabbit