Skip to content

docs: align README and contributor templates (PLT-839) #332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alexander-sei wants to merge 1 commit into
base: main
Choose a base branch
from
+51 −19
Open

docs: align README and contributor templates (PLT-839) #332

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 21 additions & 10 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,34 +3,45 @@ name: Bug report
about: Create a report to help us improve
title: "[BUG] Issue Title"
labels: bug, linear
assignees: ''
assignees: ""

---

**Seid version**
Show us output of `seid version --long | head`
**Affected package and version**
Select the affected package and provide its exact version:

**SeiJS package & version**
Check your `package.json` for version number and package (core/react/proto)
- [ ] `@sei-js/create-sei`
- [ ] `@sei-js/mcp-server`
- [ ] `@sei-js/precompiles`
- [ ] `@sei-js/registry`
- [ ] `@sei-js/sei-global-wallet`

**Chain ID**
Which chain are you running into issues with?
Version:

**Environment**
- Runtime or browser and version:
- Operating system:
- Wallet or provider, if applicable:
- Sei network and chain ID:

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
**To reproduce**
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Include a minimal reproduction or code sample when possible.

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.
**Logs or screenshots**
If applicable, add logs or screenshots that help explain the problem. Remove private keys, seed phrases, and other secrets first.

**Additional context**
Add any other context about the problem here.
21 changes: 21 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## Summary

<!-- Explain what changed and why. -->

## Related issue

<!-- Link the Linear issue or other relevant context. -->

## Test plan

<!-- List the commands and manual checks used to verify this change. -->

- [ ] `bun run check`
- [ ] `bun run build`
- [ ] `bun run test`

## Checklist

- [ ] I added or updated tests where needed.
- [ ] I added a Changeset when this affects a published package.

@seidroid seidroid Bot Aug 17, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

[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.

- [ ] I updated documentation when behavior or usage changed.
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# 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.

@seidroid seidroid Bot Aug 17, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

[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.


## Packages

SeiJS consists of smaller NPM packages within the @sei-js namespace. See the package READMEs below for usage details.
SeiJS consists of packages within the `@sei-js` namespace. See the package READMEs below for usage details.

| Package | Description |
| ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| [@sei-js/precompiles](packages/precompiles) | Typescript library containing helper functions for interacting with Sei's precompile contracts. |
| [@sei-js/create-sei](packages/create-sei) | CLI Tool used to quickly spin up Sei Projects and dApps in either the cosmos or EVM ecosystem |
| [@sei-js/mcp-server](packages/mcp-server) | MCP server for interacting with Sei via LLM's and agents |
| [@sei-js/sei-global-wallet](packages/sei-global-wallet) | A global wallet conforming to EIP-6963 allowing for AA across dApps. |
| [@sei-js/registry](packages/registry) | TypeScript library for Sei chain constants and assets. |
| Package | Description |
| ------------------------------------------------------- | --------------------------------------------------------------------------------- |
| [@sei-js/precompiles](packages/precompiles) | TypeScript ABIs, addresses, and Ethers/Viem helpers for Sei EVM precompiles. |
| [@sei-js/create-sei](packages/create-sei) | CLI for scaffolding Sei EVM applications and dApps. |
| [@sei-js/mcp-server](packages/mcp-server) | MCP server that lets AI assistants and agents interact with Sei EVM. |
| [@sei-js/sei-global-wallet](packages/sei-global-wallet) | Global wallet integration for EIP-6963 and account abstraction across dApps. |
| [@sei-js/registry](packages/registry) | TypeScript library for Sei chain constants and assets. |

## Development

Expand Down
Loading