Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
86 lines (62 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

86 lines (62 loc) · 2.47 KB

Contributing to OWS

Thanks for your interest in contributing to the Open Wallet Standard! This guide will help you get started.

Development Setup

Prerequisites

Building from Source

# Clone the repo
git clone https://github.com/open-wallet-standard/core.git
cd core

# Build the Rust workspace
cd ows && cargo build --workspace --release

# Build Node bindings
cd bindings/node && npm install && npx napi build --platform --release

# Build Python bindings
cd bindings/python && maturin develop --release

Running Tests

# Rust tests
cd ows && cargo test --workspace

# Node tests
cd bindings/node && npm test

Code Formatting

cd ows && cargo fmt --all      # Format Rust code
cd ows && cargo clippy --workspace -- -D warnings  # Lint

Making Changes

  1. Fork the repo and create a branch from main.
  2. Make your changes. Keep commits focused and use conventional commit messages (e.g., feat:, fix:, chore:).
  3. Test. Ensure cargo test --workspace passes and cargo clippy is clean.
  4. Open a PR against main with a clear description of what changed and why.

Pull Request Guidelines

  • Keep PRs small and focused — one logical change per PR.
  • Update documentation if your change affects the public API or CLI.
  • Add tests for new functionality.
  • Ensure CI passes before requesting review.

Project Structure

core/
├── ows/crates/
│   ├── ows-core/      # Types, CAIP parsing, errors
│   ├── ows-signer/    # HD derivation, signing, address generation
│   ├── ows-lib/       # FFI interface for language bindings
│   └── ows-cli/       # CLI tool
├── bindings/
│   ├── node/          # Node.js NAPI bindings
│   └── python/        # Python (PyO3/Maturin) bindings
├── docs/              # Specification documents
└── website/           # Static site (openwallet.sh)

Reporting Bugs

Open a GitHub Issue with:

  • Steps to reproduce
  • Expected vs actual behavior
  • OS, Rust version, and OWS version (ows --version)

Questions?

Open a discussion or an issue — we're happy to help.