Skip to content

Latest commit

 

History

History
60 lines (45 loc) · 1.23 KB

CONTRIBUTING.md

File metadata and controls

60 lines (45 loc) · 1.23 KB

Contributing

This guide explains how to set up your development environment and contribute code to nilDB.

Prerequisites

  • Node.js >= 23
  • pnpm >= 10
  • Docker

Development Setup

  1. Clone the repository:

    git clone [email protected]:NillionNetwork/nildb.git
cd nildb

  2. Install dependencies and configure the environment:

    pnpm install
pnpm install-hooks
cp .env.example .env

Development Server

pnpm dev    # watches for changes and auto-reloads
# or
pnpm start  # runs without watching

Note

Database migrations run automatically when the node starts

Code quality

Run these checks before submitting your PR:

tsc         # type check
biome check # format and lint
pnpm test   # run the test suite

Note

  • Tests use isolated collections (test_datablocks and test_datablocks_data)
  • The test database is dropped at the start of each test run

Contributing workflow

  1. Fork the repository
  2. Open an issue to discuss proposed changes
  3. Create a branch (git switch -c <user>/amazing-feature)
  4. Implement your changes
  5. Ensure all checks pass
  6. Commit with conventional commits (feat:, fix:, etc.)
  7. Push to your fork
  8. Submit a pull request