Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (49 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

72 lines (49 loc) · 1.85 KB

Contributing to split-app

Thank you for your interest in contributing to StellarSplit! This repo is part of the Drips Wave Program — a monthly open-source bounty program run by the Stellar Development Foundation.

Before You Start

Do not begin coding until you have been assigned to an issue by a maintainer.

  1. Browse open issues and find one labelled good first issue or matching your skill level.
  2. Comment on the issue: "I'd like to work on this."
  3. Wait for a maintainer to assign you. Only then should you fork and start coding.

Workflow

1. Fork & Clone

git clone https://github.com/<your-username>/split-app.git
cd split-app
npm install

2. Set Up Environment

cp .env.example .env.local
# Fill in your testnet contract ID and RPC URL

3. Create a Branch

fix/issue-NUMBER-short-description
feat/issue-NUMBER-short-description

git checkout -b fix/issue-42-short-description

4. Make Your Changes

  • Write clean, well-typed TypeScript and React.
  • Run npm run build — must succeed with no errors.
  • Run npm run lint — no TypeScript errors.
  • Ensure all interactive elements have ARIA labels.

5. Commit

Use conventional commits:

fix: correct wallet disconnect state (#42)
feat: add invoice search to dashboard (#7)

6. Open a Pull Request

  • Title: concise, under 70 characters.
  • Description: what changed, why, and how you tested it.
  • Reference the issue: Closes #42

Code Standards

  • All components must have a JSDoc comment describing their purpose.
  • Use Tailwind utility classes — do not add custom CSS unless necessary.
  • Keep components small and focused (single responsibility).
  • All interactive elements must be keyboard-accessible.

Questions?

Open a Discussion or ask in the issue thread.