Contributing Guide

We welcome contributions from developers, researchers, designers, validators, and community members.

Ways to Contribute

Area
Examples

Code

ZK circuits, smart contracts, SDK improvements

Research

Collateral models, privacy heuristics, compliance theory

Documentation

Tutorials, architectural diagrams, clarity edits

Community

Moderation, governance analysis, education

Development Setup

# Clone the repo
git clone https://github.com/zkstable/zkstable.git
cd zkstable

# Install dependencies
pnpm install

# Start development
pnpm dev

Code Standards

  • Follow EIP-2535 modular diamond pattern conventions (where applicable)

  • PRs require unit tests and security rationale

  • All ZK circuits must include:

    • Constraint explanation

    • Soundness argument

    • Verification script

Code of Conduct

  • Respectful collaboration

  • No doxxing, harassment, or targeted attacks

  • Intellectual honesty required

Last updated