Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (25 loc) · 966 Bytes

CONTRIBUTING.md

File metadata and controls

35 lines (25 loc) · 966 Bytes

Contributing to StellarStream

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

Development Setup

  1. Clone the repository
  2. Install dependencies: npm run install:all
  3. Run the development environment: npm run dev

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

This will allow you to interactively review and accept changes to the snapshots.

Pull Request Process

  1. Create a feature branch from main.
  2. Ensure all tests pass.
  3. Update documentation if necessary.
  4. Submit a PR and wait for review.