Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (55 loc) · 2.4 KB

CONTRIBUTING.md

File metadata and controls

72 lines (55 loc) · 2.4 KB
Raw

Contributing to HorizonCover

Welcome! Incredibly excited you are interested in contributing to HorizonCover. This is an open source project and contributions are welcome.

The open source workflow

We manage all our work through the GitHub Issues board. Issues are pre-scoped and tagged with difficulty and area labels.

To ensure fair attribution for the Wave program:

  1. Find an Issue: Browse the open issues. If it is unassigned, comment "I would like to work on this."
  2. Wait for Assignment: A maintainer will formally assign the issue to you. Do not start work until you are assigned.
  3. Submit a PR: Once assigned, link your PR to the issue.
  4. Merge: Once reviewed and merged, your contribution becomes part of the open source project!

Development Setup

HorizonCover is a monorepo built with pnpm.

Prerequisites

Add the WASM compilation target (one time only):

rustup target add wasm32-unknown-unknown

Get a funded testnet account:

stellar keys generate --global contributor-key --network testnet
stellar keys fund contributor-key --network testnet

Local Setup

  1. Fork and clone the repository.
  2. Install dependencies: 
    pnpm install
  3. Build the smart contracts: 
    pnpm build:contracts
  4. Run the frontend: 
    cd frontend
pnpm dev

Git Workflow & Branching

Please branch off main using the following convention:

  • feat/issue-number-short-desc (e.g., feat/12-payout-formula)
  • fix/issue-number-short-desc (e.g., fix/14-vault-balance-bug)
  • docs/issue-number-short-desc

Commit Messages

We follow Conventional Commits. Your commit messages should look like:

  • feat(core): implement solvency check
  • fix(frontend): resolve wallet disconnect error
  • test(monitor): add mock protocol exploit simulation

Pull Request Guidelines

  1. Use the provided PR template.
  2. Reference the issue you are solving (Closes #12).
  3. Ensure all local tests pass (cargo test).
  4. Keep your PRs highly focused. If you are doing a large refactor, please open an issue to discuss it first.

Thank you for helping us build the future of parametric DeFi insurance on Stellar!