chore: public-release polish — license, CI, community files, README#1
Merged
Conversation
LICENSE is BSD-3-Clause but every package.json declared MIT (and examples/ had no license field at all). Fix all five to match.
- .github/workflows/ci.yml: forge test + ts typecheck on push/PR - CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md (Contributor Covenant v2.1) - bug_report / feature_request issue templates + PR template Standard community-health setup for a public ava-labs repo.
…s CLI framing - Disambiguate the graft/subnet-evm build step (graft/ lives in the avalanchego checkout, not in this repo); call out the subnet-evm plugin VM ID so users can verify the plugin landed. - New Troubleshooting section covering common first-run failures: AVALANCHEGO_PATH, missing plugin, stale state, missing forge, ports. - packages/tmpnetjs/README.md: note the package is not on npm; use pnpm scripts or direct bin invocation from the repo, not a global CLI.
`forge install --no-git` strips the .git directory of cloned deps, which then breaks recursive submodule init inside icm-contracts (it depends on subnet-evm as a git submodule). Symptom in CI: fatal: not a git repository: ../../.git/modules/lib/subnet-evm Clone the three deps directly with --recurse-submodules instead — no forge magic, predictable behavior.
Apply canonical forge fmt to bring the tree in line with the new CI fmt check.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Gets the repo ready to flip public on github.com/ava-labs/interchain-kit. Three logical changes:
package.jsonlicense fields with the actual LICENSE (BSD-3-Clause). Everypackage.jsonpreviously declared MIT;examples/had no license field at all..github/community-health setup: CI workflow (forge test+ TS typecheck),CONTRIBUTING.md,SECURITY.md,CODE_OF_CONDUCT.md(Contributor Covenant v2.1), bug-report + feature-request issue templates, PR template.graft/subnet-evmprereq (graft/ lives in the avalanchego checkout, not in this repo), call out the subnet-evm plugin VM ID for users to verify, add a Troubleshooting section, and softentmpnetjsREADME's CLI framing (the package isn't on npm — drive it viapnpm run upor the direct bin path).What changed
package.json× 5 →BSD-3-Clause.github/workflows/ci.yml(forge test + typecheck; pinsforge-std@v1.9.4,openzeppelin-contracts-upgradeable@v5.0.2,icm-contracts@v1.0.9, recursive submodule init for subnet-evm)CONTRIBUTING.md,SECURITY.md,CODE_OF_CONDUCT.md.github/ISSUE_TEMPLATE/{bug_report,feature_request}.md,.github/PULL_REQUEST_TEMPLATE.mdREADME.md(prereq clarity + Troubleshooting)packages/tmpnetjs/README.md(CLI framing)How to verify
forge installpins resolve correctly, especially the nestedsubnet-evmsubmodule insidelib/icm-contracts)pnpm install --frozen-lockfileclean locally (verified)security@avalabs.orgis the right CoC enforcement contact (currently uses the security inbox — people-ops may prefer a different address)SECURITY.md(icm-contracts/avalanchego only advertise Immunefi)Not in this PR (manual followups)
README.mdstill points at agithub.com/user-attachments/...URL that only resolves for the original uploader. Save the logo locally todocs/logo.pngand update line 2 of the README to./docs/logo.png.