Skip to content

Update README to reflect published status on crates.io#24

Merged
satyakwok merged 1 commit into
mainfrom
satyakwok-patch-1
May 13, 2026
Merged

Update README to reflect published status on crates.io#24
satyakwok merged 1 commit into
mainfrom
satyakwok-patch-1

Conversation

@satyakwok
Copy link
Copy Markdown
Member

@satyakwok satyakwok commented May 13, 2026

Summary

What changed and why. 1-3 sentences.

Scope

  • Contract change (new file or logic edit) — needs slither pass + audit consideration
  • Test-only change
  • Deploy script / CI / docs only
  • Repo tooling (Makefile, lefthook, etc.)

Checks

  • forge build clean
  • forge test green (including fuzz + invariant)
  • forge fmt --check clean
  • slither --no-fail-pedantic reviewed (no new high-severity findings)
  • Storage layout diff reviewed if any contract field added/removed (run make storage and inspect docs/storage/*.json)

Linked issue

Closes #

Deploy impact

  • No on-chain change (test/CI/docs only)
  • Requires v-bump + redeploy when shipped
  • Backwards-compatible (extends, doesn't reorder storage)
  • Breaking — needs migration plan in RELEASES.md

Summary by CodeRabbit

  • Documentation
    • Updated project roadmap to reflect completion of crates.io publication milestone.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 13, 2026

📝 Walkthrough

Walkthrough

The PR updates the README.md roadmap section by marking the "Published to crates.io once feature surface stabilises" item as completed, changing the checkbox from unchecked to checked. This is a single-line documentation update with no code changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description follows the template structure but lacks substantive content in critical sections, particularly the Summary section which is empty. Fill in the Summary section with 1-3 sentences explaining what changed and why. Uncheck irrelevant scope items and verify all checks are accurate for this documentation-only change.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: updating the README to reflect that the crate has been published on crates.io, matching the single-line checkbox update in the Roadmap section.
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 docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch satyakwok-patch-1

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

@satyakwok satyakwok merged commit 7a7d0bc into main May 13, 2026
5 checks passed
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