Skip to content

Conversation

@maradini77
Copy link
Contributor

  • Fix preposition and hyphenation in contracts/governance/README.adoc.
  • Fix CI wording in fv/README.md.

@maradini77 maradini77 requested a review from a team as a code owner December 22, 2025 10:57
@changeset-bot
Copy link

changeset-bot bot commented Dec 22, 2025

⚠️ No Changeset found

Latest commit: af8b042

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 22, 2025

Walkthrough

This pull request contains minor documentation updates across two README files. The contracts/governance/README.adoc file is updated to correct grammar by adding the preposition "of" in the phrase "deployment of on-chain voting protocols". The fv/README.md file is revised to adjust phrasing, changing "run on a GitHub Actions' CI environment" to "run in a GitHub Actions CI environment", removing an apostrophe and replacing "on" with "in" for improved clarity.

Possibly related PRs

  • docs: fix typo #6176: Both PRs apply minor documentation typo fixes to the same file (contracts/governance/README.adoc)

Suggested labels

typo

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: fixing documentation typos in two README files (governance and FV guides).
Description check ✅ Passed The description is directly related to the changeset, providing specific details about which files were changed and what types of fixes were 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 92b5370.

📒 Files selected for processing (2)
  • contracts/governance/README.adoc
  • fv/README.md
⏰ 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). (9)
  • GitHub Check: Redirect rules - solidity-contracts
  • GitHub Check: tests
  • GitHub Check: slither
  • GitHub Check: tests-foundry
  • GitHub Check: Header rules - solidity-contracts
  • GitHub Check: coverage
  • GitHub Check: tests-upgradeable
  • GitHub Check: halmos
  • GitHub Check: Pages changed - solidity-contracts
🔇 Additional comments (2)
contracts/governance/README.adoc (1)

10-10: Grammar fix is correct.

Adding the preposition "of" properly completes the noun phrase. "Deployment of on-chain voting protocols" is grammatically sound.

fv/README.md (1)

12-12: Wording improvements are clear and correct.

Removing the unnecessary apostrophe from "GitHub Actions'" and changing the preposition from "on" to "in" improves both correctness (GitHub Actions is not possessive) and readability. The revised sentence is more natural and idiomatic.


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.

@Amxx Amxx changed the base branch from master to typo-fixes December 22, 2025 21:45
@Amxx Amxx added this to the typo-fixes milestone Dec 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants