Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (43 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

62 lines (43 loc) · 1.86 KB

Contributing to ZeroID

Thank you for your interest in contributing to ZeroID! This guide will help you get started.

Code of Conduct

By participating, you agree to uphold a welcoming, respectful, and harassment-free environment for everyone.

Getting Started

  1. Fork the repository
  2. Clone your fork locally
  3. Install dependencies: npm ci
  4. Create a feature branch: git checkout -b feature/my-feature

Development Workflow

Prerequisites

Tool Version
Node.js >= 20.0.0
Rust >= 1.75.0
Circom >= 2.1.0
Foundry latest
Docker + Compose latest
PostgreSQL >= 16

Before Submitting

Run the full validation suite:

npm run validate       # lint + type-check + format
npm run test:ci        # frontend tests with coverage
forge test             # smart contract tests

Pull Request Guidelines

  1. Branch naming: feature/, fix/, docs/, refactor/, test/
  2. Commit messages: Follow Conventional Commits
  3. Tests: Add or update tests for your changes
  4. One concern per PR: Keep PRs focused and reviewable

Areas of Contribution

  • Frontend (Next.js / React / Tailwind) — src/
  • Backend API (Express / TypeScript) — backend/
  • Smart Contracts (Solidity / Foundry + Hardhat) — contracts/
  • ZK Circuits (Circom / snarkjs) — circuits/
  • Rust TEE — crates/zeroid-tee/
  • Go SDK — sdk/go/
  • Python SDK — sdk/python/

Security Issues

Do NOT file security issues as public GitHub issues. See SECURITY.md for responsible disclosure instructions.

License

By contributing, you agree that your contributions will be licensed under the Apache 2.0 License.