docs: align README and contributor templates (PLT-839) - #332
docs: align README and contributor templates (PLT-839)#332alexander-sei wants to merge 1 commit into
Conversation
Co-authored-by: Cursor <cursoragent@cursor.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #332 +/- ##
=======================================
Coverage 83.82% 83.82%
=======================================
Files 64 64
Lines 4390 4390
=======================================
Hits 3680 3680
Misses 710 710
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
![seidroid[bot]](https://avatars.githubusercontent.com/in/2745135?s=60&v=4){kind=small}
There was a problem hiding this comment.
Docs-and-templates-only PR that accurately corrects real drift: the removed cosmos/seid references match the current EVM-only create-sei, all five README package rows match the actual tree, and the new PR template references root scripts that exist. Nothing blocking; one wording nit and a note that the Cursor pass returned no output.
Findings: 0 blocking | 5 non-blocking | 2 posted inline
Blockers
- None at the file/PR level.
Non-blocking
- The Cursor second-opinion pass (
cursor-review.md) produced no output — this review reflects only my own findings plus Codex's, which reported no material issues. - No changeset is present, which is correct here per REVIEW_GUIDELINES §3 (docs- and CI-only changes don't need one). The author called this out in the PR body; noting it only so it isn't re-raised.
- The new bug report template asks reporters to remove private keys and seed phrases before pasting logs — a good addition given
mcp-serverreads signing keys from the environment. Consider mirroring that warning in the PR template's Test plan section, since debugging output gets pasted there too. - 2 suggestion(s)/nit(s) flagged inline on specific lines.
| # SeiJS | ||
|
|
||
| SeiJS is a monorepo that contains multiple NPM libraries for writing applications that interact with Sei. | ||
| SeiJS is a monorepo of npm packages for building EVM applications on Sei. |
There was a problem hiding this comment.
[nit] Nit: "for building EVM applications on Sei" slightly under-sells @sei-js/registry, which vends chain constants, tokens and wallet metadata sourced from the cosmos chain-registry / community-assetlist submodules and isn't EVM-specific. The narrowing is accurate for the other four packages (create-sei really is EVM-only now — no cosmos/cosmjs references remain in its src/), so this is just a tagline-precision point. Something like "for building on Sei, with first-class EVM support" would cover registry too. Non-blocking.
| ## Checklist | ||
|
|
||
| - [ ] I added or updated tests where needed. | ||
| - [ ] I added a Changeset when this affects a published package. |
There was a problem hiding this comment.
[nit] Good that the checklist calls out Changesets explicitly — that's the most common miss on this repo (a published package's behavior changing with no .changeset/*.md ships code without releasing it). Might be worth linking .changeset/config.json or noting bun run changeset inline so contributors know the command, since there's no CONTRIBUTING.md in the repo to point at. Non-blocking.
2 participants
Summary
seidand removed-package prompts in the bug report templateRelated issue
PLT-839
Test plan
bun run checkgit diff --checkChangeset not required because this only updates repository documentation and contribution templates.
Made with Cursor