Skip to content

Update readme#540

Merged
andrew-fleming merged 1 commit into
OpenZeppelin:mainfrom
andrew-fleming:update-readme
Jun 4, 2026
Merged

Update readme#540
andrew-fleming merged 1 commit into
OpenZeppelin:mainfrom
andrew-fleming:update-readme

Conversation

@andrew-fleming
Copy link
Copy Markdown
Contributor

@andrew-fleming andrew-fleming commented Jun 4, 2026

Summary by CodeRabbit

  • Documentation
    • Updated README installation instructions for @openzeppelin/compact-contracts using the yarn add command.
    • Revised custom contract example with updated import paths (from local submodule paths to node_modules references) and updated constructor/circuit code to match the new module layout.
    • Updated contract compilation example output and provided revised guidance to reflect the changes.

@andrew-fleming andrew-fleming requested review from a team as code owners June 4, 2026 18:44
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 4, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 605d64ee-6936-4d47-ac40-3ab16d9dc6e6

📥 Commits

Reviewing files that changed from the base of the PR and between b33b4fb and ac6a64a.

📒 Files selected for processing (1)
  • README.md

Walkthrough

README updated to document npm-based installation via yarn add @openzeppelin/compact-contracts``, replacing submodule setup instructions. Example contract imports and usage are revised to reference node_modules paths, and the compile walkthrough output is updated to reflect 14 circuits instead of 3.

Changes

README Documentation Update

Layer / File(s) Summary
Installation and usage example
README.md
Installation instructions changed from git submodule setup to npm package install. Example contract code updated with new import paths (./node_modules/...) and corresponding module usage patterns.
Compile command walkthrough
README.md
Compile section example output updated to show 14 circuits compiled, reflecting the revised contract example and matching the new module layout.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

📚 A README renewed, so clear and so bright,
From submodules past to npm's delight,
Fourteen circuits now dance in the compile,
Fresh paths and examples make setup worthwhile,
Documentation refreshed, the guide shines anew! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Update readme' is vague and generic, using non-descriptive language that doesn't convey specific information about what aspect of the README was changed. Use a more specific title that indicates which README section or feature was updated, such as 'Update README with yarn installation and contract example' or similar.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Copy link
Copy Markdown
Member

@0xisk 0xisk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! @andrew-fleming TY!

@andrew-fleming andrew-fleming merged commit 5462978 into OpenZeppelin:main Jun 4, 2026
6 checks passed
@andrew-fleming andrew-fleming deleted the update-readme branch June 4, 2026 18:52
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.

2 participants