Skip to content

AntSeed/.github

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 

Repository files navigation

Contributing to AntSeed

Thank you for your interest in contributing. AntSeed is developed as a monorepo using pnpm workspaces.


Development Setup

git clone https://github.com/AntSeed/antseed
cd antseed
pnpm install
pnpm run build

Run tests:

pnpm run test

Type-check:

pnpm run typecheck

Repository Structure

Area Location
Protocol SDK packages/node
Provider infrastructure packages/provider-core
Router infrastructure packages/router-core
Provider plugins plugins/provider-*
Router plugins plugins/router-*
CLI apps/cli
Desktop app apps/desktop
Dashboard apps/dashboard
Website apps/website
Protocol spec docs/protocol
End-to-end tests e2e/

Pull Requests

  • Keep PRs focused — one change per PR
  • Add or update tests for any changed behaviour
  • Run pnpm run build and pnpm run test before opening a PR
  • Describe why the change is needed, not just what it does

Issues

Use the issue templates in the monorepo. For protocol-level changes, reference docs/protocol.


Publishing a Plugin

You do not need to contribute to this org to publish an AntSeed plugin. Implement the AntseedProviderPlugin or AntseedRouterPlugin interface from @antseed/node and publish your package to npm. See the plugin docs for interface definitions and walkthroughs.


Code Style

  • TypeScript strict mode throughout
  • ES modules only
  • No default exports except for plugin entry points
  • Prefer explicit types over inference in public APIs

About

AntSeed organization profile and community files

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors