Repository navigation
docs: restore the EVM compatibility issue template and SLA (PLT-837) - #361
alexander-sei wants to merge 1 commit into
Conversation
Restores the evm_compatibility issue template and the evm-compat triage SLA that were reverted on the sdk-evm-parity branch. Devnet is gone from the network list, the package checklist matches bug_report.md, and both files link to the EVM parity matrix in sei-docs. Co-authored-by: Cursor <cursoragent@cursor.com>
PR SummaryLow Risk Reviewed by Cursor Bugbot for commit 9d758eb. Bugbot is set up for automated code reviews on this repo. Configure here. |
There was a problem hiding this comment.
This PR only adds documentation: an EVM compatibility issue template and a triage SLA. Nothing in it touches published packages, so it needs no changeset. A few small notes cover a label that doesn't exist yet, links that won't work until sei-docs#103 merges, and overlapping classification wording.
Findings: 0 blocking | 6 non-blocking | 2 posted inline
Blockers
- None at the file/PR level.
Non-blocking
- The Codex review file (codex-review.md) was empty, so that pass gave no findings.
- The Cursor review file (cursor-review.md) was empty, so that pass gave no findings.
- The
evm-compatlabel doesn't exist in this repo yet, and the PR description says so. Until someone creates it, issues opened from the template only getlinear, and the SLA's weekly-review query (label:evm-compat) returns nothing. Create the label before merging, or right after. - Links to docs.sei.io/evm/sei-js/evm-parity (and the evm-compatibility page linked from the SLA) won't work until sei-protocol/sei-docs#103 merges. The suggested order (this PR first) means the template will point at missing pages for a short time. Consider merging the two close together.
- 2 suggestion(s)/nit(s) flagged inline on specific lines.
|
|
||
| | Classification | Meaning | Outcome | | ||
| | --- | --- | --- | | ||
| | SDK gap | An `@sei-js` package, template, or sei-js docs page needs a change. | Fix it in this repository, then update the matrix cell in sei-docs. | |
There was a problem hiding this comment.
[nit] "SDK gap" includes "sei-js docs page", but the "Docs issue" row covers "A sei-docs page is wrong or missing". In the template both options just say "docs page", so reporters and triagers won't know which one to pick for a documentation problem. Suggest saying explicitly which docs belong to each bucket (e.g. in-repo READMEs → SDK gap, docs.sei.io → Docs issue).
| - [ ] SDK gap: an `@sei-js` package, template, or docs page needs a change | ||
| - [ ] Network issue: the RPC response differs from documented Sei behavior | ||
| - [ ] Upstream issue: the behavior comes from viem, wagmi, ethers, or a wallet | ||
| - [ ] Docs issue: a docs page is wrong or missing |
There was a problem hiding this comment.
[nit] This overlaps with the "SDK gap" option on line 53, which also mentions a "docs page". Consider writing "Docs issue: a docs.sei.io page is wrong or missing" to match the SLA's split.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #361 +/- ##
=======================================
Coverage 96.53% 96.53%
=======================================
Files 81 81
Lines 5563 5563
=======================================
Hits 5370 5370
Misses 193 193
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:
|
Summary
.github/ISSUE_TEMPLATE/evm_compatibility.md) from the revertedsdk-evm-paritywork, updated for the current repo: the package checklist matchesbug_report.md, devnet is gone from the network list, and the template points reporters at the EVM parity matrix firstevm-compattriage SLA as.github/EVM_COMPAT_SLA.md: the 14-day target, required details, classification, aging, closure, and weekly review rulesRelated issue
PLT-837
Test plan
bun run checkgit diff --checkbug_report.md)Changeset not required because this only adds a contribution template and repository documentation.
Notes
evm-compatlabel does not exist on this repository yet. Until it is created, GitHub applies only thelinearlabel from the template.docs.sei.io/evm/sei-js/evm-parity, which goes live when docs(sei-js): add the EVM parity matrix and plan (PLT-837) sei-docs#103 merges. The sei-docs pages link back to these two files, so merge this PR first.Made with Cursor