Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (38 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

62 lines (38 loc) · 1.77 KB
Raw

Contributing to StellarStream

Thank you for your interest in contributing to StellarStream! This guide will help you get started with our development process.

Check out the FAQ.md for common contributor questions and troubleshooting tips.

Code of Conduct

Participation in this project is governed by our Code of Conduct. By contributing, you are expected to uphold this standard.

Security

If you discover a security vulnerability, please follow our Security Policy and report it privately via the GitHub Security Advisory form. Do not open public issues for security concerns.

Development Setup

  1. Clone the repository
  2. Install dependencies: npm run install:all
  3. Seed demo data: node scripts/seed-streams.js --reset
  4. Run the development environment: npm run dev

Seeding Demo Data

To populate your local database with deterministic demo streams:

# Seed 10 default streams
node scripts/seed-streams.js

# Seed custom number of streams
node scripts/seed-streams.js --count 20

# Reset database and seed
node scripts/seed-streams.js --reset

# Combine options
node scripts/seed-streams.js --reset --count 15

The seed script creates streams across all statuses (scheduled, active, paused, completed, canceled) with deterministic data, ensuring consistent results on every run when the database is empty.

Testing

Backend Tests

Run npm run test in the backend/ directory.

Contract Tests

Run cargo test in the contracts/ directory.

Snapshot Testing

We use insta for snapshot testing of contract events.
Snapshot files are located in contracts/test_snapshots/.

To update snapshots: If you change event structures and need to update the snapshots, run:

cargo insta review