Add notice about the use of NPM tags in README.md #6050
Conversation
|
WalkthroughThis pull request updates the README.md documentation to clarify NPM release tag semantics. A new "Release tags" section is added that explains the distinction between Possibly related PRs
Suggested labels
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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: 0
🧹 Nitpick comments (1)
README.md (1)
37-45: Address markdown lint warnings in Hardhat installation section.The markdown linter flags style issues in the fenced code blocks:
- Line 37, 42: Code blocks should specify a language (MD040). These should use
```bashor```shellfor proper syntax highlighting.- Line 38, 43: Dollar signs used before commands without output (MD014). While this pattern works in documentation, the linter recommends removing the
$prefix or showing command output.Apply this diff to fix the markdown style issues:
- ``` + ```bash $ npm install @openzeppelin/contracts - ``` + ``` → Installs the latest audited release (`latest`). - ``` + ```bash $ npm install @openzeppelin/contracts@dev - ``` + ```Alternatively, remove the
$prefix entirely if no output is being shown:- ```bash - $ npm install @openzeppelin/contracts + ```bash + npm install @openzeppelin/contracts - ``` + ``` → Installs the latest audited release (`latest`). - ```bash - $ npm install @openzeppelin/contracts@dev + ```bash + npm install @openzeppelin/contracts@dev - ``` + ```
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-09-04T09:13:21.278Z
Learnt from: Amxx
Repo: OpenZeppelin/openzeppelin-contracts PR: 5904
File: contracts/crosschain/ERC7786Recipient.sol:3-3
Timestamp: 2025-09-04T09:13:21.278Z
Learning: In OpenZeppelin contracts, hardhat.config.js uses a sophisticated yargs-based configuration where the Solidity compiler version is set via argv.compiler (line 77) with a default of '0.8.27' defined in the yargs options (line 21), allowing flexible command-line overrides while maintaining a consistent default.
Applied to files:
README.md
🪛 markdownlint-cli2 (0.18.1)
README.md
37-37: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
38-38: Dollar signs used before commands without showing output
(MD014, commands-show-output)
42-42: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
43-43: Dollar signs used before commands without showing output
(MD014, commands-show-output)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)
- GitHub Check: Redirect rules - solidity-contracts
- GitHub Check: Header rules - solidity-contracts
- GitHub Check: Pages changed - solidity-contracts
- GitHub Check: slither
- GitHub Check: coverage
- GitHub Check: tests
- GitHub Check: tests-foundry
- GitHub Check: halmos
🔇 Additional comments (1)
README.md (1)
23-31: Well-structured documentation clarifying NPM tag semantics.The new "Release tags" section effectively explains the purpose of each NPM tag and helps users understand the distinction between audited (
latest), finalized-but-unaudited (dev), and pre-release (next) versions. This directly addresses the issue where the v5.5.0 release was incorrectly tagged, and now provides clear guidance to users on which version to install based on their needs.
2 participants
Fixes #6038 and #6047