Conversation
Signed-off-by: rehannadaf2 <ajitporval@gmail.com>
WalkthroughInstallation instructions were added to the README documenting setup procedures for both Forge-based and Hardhat/npm-based project configurations. The additions were inserted in the License section and provide direct commands for package installation. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 149: Update the README heading "Hardhat / npm based projects" to use a
hyphenated compound adjective by changing it to "Hardhat / npm-based projects"
so the heading reads correctly; locate the heading text in the README and
replace "npm based" with "npm-based".
- Around line 145-150: Remove the duplicated installation block under the
License section by deleting the "Forge projects" and "Hardhat / npm based
projects" commands (the two lines starting with "forge install
https://github.com/thirdweb-dev/contracts" and "npm i `@thirdweb-dev/contracts`"),
leaving the canonical installation instructions that already exist under the "##
Installation" section (the block around lines 16-24); ensure no other duplicate
install snippets remain in the README so installation is documented in one place
only.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
|
|
||
| # Forge projects | ||
| forge install https://github.com/thirdweb-dev/contracts | ||
|
|
||
| # Hardhat / npm based projects | ||
| npm i @thirdweb-dev/contracts |
There was a problem hiding this comment.
Remove duplicated installation block from the License section.
These commands are already documented under ## Installation (Line 16-24). Keeping a second copy under ## License makes the README harder to maintain and easy to drift over time. Consider deleting this block here and keeping installation instructions in one place only.
Suggested diff
## License
[Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt)
-
-# Forge projects
-forge install https://github.com/thirdweb-dev/contracts
-
-# Hardhat / npm based projects
-npm i `@thirdweb-dev/contracts`📝 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. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # Forge projects | |
| forge install https://github.com/thirdweb-dev/contracts | |
| # Hardhat / npm based projects | |
| npm i @thirdweb-dev/contracts | |
| ## License | |
| [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt) |
🧰 Tools
🪛 LanguageTool
[grammar] ~149-~149: Use a hyphen to join words.
Context: .../thirdweb-dev/contracts # Hardhat / npm based projects npm i @thirdweb-dev/contr...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 145 - 150, Remove the duplicated installation block
under the License section by deleting the "Forge projects" and "Hardhat / npm
based projects" commands (the two lines starting with "forge install
https://github.com/thirdweb-dev/contracts" and "npm i `@thirdweb-dev/contracts`"),
leaving the canonical installation instructions that already exist under the "##
Installation" section (the block around lines 16-24); ensure no other duplicate
install snippets remain in the README so installation is documented in one place
only.
| # Forge projects | ||
| forge install https://github.com/thirdweb-dev/contracts | ||
|
|
||
| # Hardhat / npm based projects |
There was a problem hiding this comment.
Use hyphenated compound adjective in heading text.
Use npm-based instead of npm based for consistency and grammar.
Suggested diff
-# Hardhat / npm based projects
+# Hardhat / npm-based projects📝 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. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # Hardhat / npm based projects | |
| # Hardhat / npm-based projects |
🧰 Tools
🪛 LanguageTool
[grammar] ~149-~149: Use a hyphen to join words.
Context: .../thirdweb-dev/contracts # Hardhat / npm based projects npm i @thirdweb-dev/contr...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 149, Update the README heading "Hardhat / npm based
projects" to use a hyphenated compound adjective by changing it to "Hardhat /
npm-based projects" so the heading reads correctly; locate the heading text in
the README and replace "npm based" with "npm-based".
1 participant
Summary by CodeRabbit