From 86c8e085a8e1a0fd333f0c2f5902d4bb5609637c Mon Sep 17 00:00:00 2001 From: alexander-sei Date: Mon, 17 Aug 2026 22:50:19 +0200 Subject: [PATCH] docs: align repository guidance with current packages (PLT-839) Co-authored-by: Cursor --- .github/ISSUE_TEMPLATE/bug_report.md | 31 +++++++++++++++++++--------- .github/pull_request_template.md | 21 +++++++++++++++++++ README.md | 18 ++++++++-------- 3 files changed, 51 insertions(+), 19 deletions(-) create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index d6fba990e..663081fad 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..07b55b14c --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,21 @@ +## Summary + + + +## Related issue + + + +## Test plan + + + +- [ ] `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. +- [ ] I updated documentation when behavior or usage changed. diff --git a/README.md b/README.md index 65d1d5dee..4fc1a9a94 100644 --- a/README.md +++ b/README.md @@ -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. ## 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