Skip to content

Conversation

@viktorking7
Copy link

Fixes typos, grammar issues, and removes duplicate content:

  • CHANGELOG.md

    • Fix hyphenation: "no-longer" → "no longer"
    • Remove duplicate entry for AccountERC7579 bug fix
  • contracts/access/README.adoc

    • Fix compound adjective: "role based" → "role-based"
  • contracts/crosschain/README.adoc

    • Fix subject-verb agreement: "messages that follows" → "messages that follow"
  • contracts/interfaces/README.adoc

    • Normalize list marker formatting

@viktorking7 viktorking7 requested a review from a team as a code owner December 20, 2025 18:23
@changeset-bot
Copy link

changeset-bot bot commented Dec 20, 2025

⚠️ No Changeset found

Latest commit: d73caee

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 20, 2025

Walkthrough

This PR contains minor documentation and changelog corrections across multiple files. The changes include fixing spacing in CHANGELOG.md ("no-longer" to "no longer"), removing duplicate entries, correcting hyphenation in README files ("role based" to "role-based"), fixing grammar in crosschain documentation ("follows" to "follow"), reinstating a BridgeERC7802 reference, and correcting list formatting in the interfaces README (IERC7751 entry). No code functionality is affected.

Possibly related PRs

Suggested labels

typo

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main changes: fixing typos, grammar errors, and documentation issues across multiple files.
Description check ✅ Passed The description is directly related to the changeset, providing specific details about the files modified and the exact corrections made.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 308c491 and d73caee.

📒 Files selected for processing (4)
  • CHANGELOG.md (1 hunks)
  • contracts/access/README.adoc (1 hunks)
  • contracts/crosschain/README.adoc (2 hunks)
  • contracts/interfaces/README.adoc (1 hunks)
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: ernestognw
Repo: OpenZeppelin/openzeppelin-contracts PR: 5904
File: contracts/crosschain/README.adoc:1-1
Timestamp: 2025-08-28T15:48:30.716Z
Learning: ernestognw prefers "Cross chain" without hyphenation rather than "Cross-chain" in documentation titles.
📚 Learning: 2025-10-03T13:14:57.679Z
Learnt from: Amxx
Repo: OpenZeppelin/openzeppelin-contracts PR: 5914
File: contracts/crosschain/bridges/BridgeERC20.sol:57-58
Timestamp: 2025-10-03T13:14:57.679Z
Learning: In cross-chain bridge contracts like BridgeERC20, when processing incoming messages in _processMessage, avoid validation checks that revert on malformed addresses. Reverting would create cross-chain inconsistency where tokens are locked/burned on the source chain but never minted on the destination. Instead, use best-effort address extraction (e.g., address(bytes20(toBinary))) to maintain atomicity across chains. If tokens are minted to an incorrect address due to user error, recovery may be possible through admin controls rather than leaving funds permanently locked.

Applied to files:

  • contracts/crosschain/README.adoc
📚 Learning: 2025-08-28T15:48:30.716Z
Learnt from: ernestognw
Repo: OpenZeppelin/openzeppelin-contracts PR: 5904
File: contracts/crosschain/README.adoc:1-1
Timestamp: 2025-08-28T15:48:30.716Z
Learning: ernestognw prefers "Cross chain" without hyphenation rather than "Cross-chain" in documentation titles.

Applied to files:

  • contracts/crosschain/README.adoc
📚 Learning: 2025-08-29T13:16:08.640Z
Learnt from: Amxx
Repo: OpenZeppelin/openzeppelin-contracts PR: 5904
File: contracts/mocks/crosschain/ERC7786RecipientMock.sol:12-14
Timestamp: 2025-08-29T13:16:08.640Z
Learning: In OpenZeppelin contracts, mock contracts (like ERC7786RecipientMock) don't require input validation such as zero-address checks in constructors, as they are only used for testing purposes in controlled environments.

Applied to files:

  • contracts/crosschain/README.adoc
⏰ 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). (7)
  • GitHub Check: Redirect rules - solidity-contracts
  • GitHub Check: Header rules - solidity-contracts
  • GitHub Check: Pages changed - solidity-contracts
  • GitHub Check: coverage
  • GitHub Check: tests
  • GitHub Check: tests-upgradeable
  • GitHub Check: tests-foundry
🔇 Additional comments (5)
contracts/access/README.adoc (1)

10-10: Compound adjective hyphenation correction — LGTM.

Line 10 correctly uses "role-based" (hyphenated compound adjective) instead of "role based" when modifying "access control mechanism". This follows standard English grammar conventions.

contracts/interfaces/README.adoc (1)

56-56: List formatting consistency — LGTM.

Line 56 standardizes the IERC7751 list marker to match the single-dash format used consistently throughout the rest of the "List of standardized interfaces" section.

CHANGELOG.md (1)

5-5: Typographical correction — LGTM.

Line 5 corrects "no-longer" to "no longer" (two words, standard English form). The hyphenated version is non-standard for this phrase.

contracts/crosschain/README.adoc (2)

6-6: Grammar correction for plural subject — LGTM.

Line 6 correctly changes "follows" to "follow" to agree with the plural subject "messages". The sentence now properly reads: "messages that follow the ERC-7786 standard" rather than the grammatically incorrect "messages that follows".


29-29: BridgeERC7802 reference restored — LGTM.

Line 29 restores the {{BridgeERC7802}} documentation block, ensuring consistency with the mention in line 13 and providing complete documentation coverage for the Bridges section.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant