Add setup-sui-contracts skill#10
Open
bidzyyys wants to merge 4 commits into
Open
Conversation
Add an instructional setup skill for scaffolding Sui Move projects with OpenZeppelin Contracts for Sui, mirroring the existing setup-* skills. The skill is methodology-first: it teaches the library's discovery chain (llms.txt -> package catalogs -> package READMEs -> examples -> API/code docs) rather than enumerating components, so it stays correct as the library grows. It covers: installing the pinned Sui CLI, `sui move new`, wiring MVR deps via `r.mvr` (incl. the `override = true` fix for diamond dependencies), studying examples and docs before implementing (incl. `sui move build --doc`), Sui testing conventions (OTW `init_for_testing`, Clock, assertion lint rule), generating a lean AGENTS.md + CLAUDE.md, code quality via STYLEGUIDE.md, prettier-move formatting, and building/testing with `--build-env testnet`. Validated by six independent cold-start runs: a fresh agent, given only the skill, composed role-based access control + rate limiter + fixed-point math + decimal scaling into one module with green build/test/lint/prettier/doc.
There was a problem hiding this comment.
Pull request overview
Adds a new setup-sui-contracts skill that guides users through scaffolding a Sui Move project that integrates OpenZeppelin Contracts for Sui, with an emphasis on discovering the correct packages/modules via the library’s own metadata and examples.
Changes:
- Added
skills/setup-sui-contracts/SKILL.mdwith end-to-end guidance for installing Sui, creating a Move package, adding OZ deps via MVR, and recommended build/test/docs workflows. - Updated the root
README.mdskills table to include the newsetup-sui-contractsentry.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| skills/setup-sui-contracts/SKILL.md | Introduces the new Sui setup skill and its methodology-first workflow. |
| README.md | Adds the new skill to the “Available Skills” table. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…he note Generalize dependency discovery to read the full set of package catalogs from llms.txt rather than naming a fixed set, so the skill stays correct as new top-level catalogs are added. State the catalog-path rule generically (resolve a package Path against its catalog's directory) instead of by example. Remove the numeric-suffixed build-cache directory aside.
…og Docs link Address PR review: the API reference URL hard-coded `1.x`, which drifts on a docs major bump. Use a `<major>.x` placeholder and point readers at the `Docs` link in each catalog table, which always carries the correct version. Applies to both the skill body and the generated AGENTS.md template.
The prereq said to confirm the local install "matches" the pinned version, which is too strict — a newer patch/minor works in practice (verified on 1.74.1 against a 1.73.2 pin). Reframe as: match the pin when you can (it's the tested version), but treat a small drift as a warning, not a blocker.
0xNeshi
approved these changes
Jul 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new
setup-sui-contractsskill — an instructional guide for scaffolding a Sui Move project that integrates OpenZeppelin Contracts for Sui, mirroring the existingsetup-*-contractsskills.The skill is methodology-first: it teaches the library's discovery chain (
llms.txt→ package catalogs → package READMEs →examples/→ API & code docs) rather than enumerating components, so it stays correct as the library grows.What it covers
sui move new, then wire OZ dependencies from the Move Registry viar.mvr.override = truefix for diamond dependencies (e.g.integer-math+fixed-point-math).sui move build --doc.init_for_testing,Clocktest helpers + the no-Clock-in-inittwo-step constraint, and the--warnings-are-errorsassertion lint rule.AGENTS.md+CLAUDE.md(mirroring contracts-sui's own convention).STYLEGUIDE.mdand@mysten/prettier-plugin-moveformatting.--build-env testnet.Tracking issue: OpenZeppelin/contracts-sui#421 (skill lives here; issue tracked in contracts-sui).