Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
89 lines (61 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

89 lines (61 loc) · 1.63 KB

Contributing to KnowledgeFlow

Thank you for your interest in contributing! This document covers everything you need to get started.

Code of Conduct

This project follows the Contributor Covenant Code of Conduct. By participating, you agree to uphold it.

Getting Started

  1. Fork the repository
  2. Create a feature branch: git checkout -b feat/my-feature
  3. Make your changes and add tests
  4. Ensure all CI checks pass
  5. Open a pull request against main

Development Setup

Frontend

cd frontend
npm install
npm run dev

Contracts (Soroban)

cd contracts
cargo test

Backend

cd backend
npm install
npm run dev

Pull Request Process

  1. Ensure the app builds without errors: npm run build
  2. No existing functionality is broken
  3. UI changes are responsive
  4. Code follows existing patterns
  5. Linting passes: npm run lint
  6. Fill out the PR template completely
  7. Update CHANGELOG.md for user-facing changes

Commit Style

Follow Conventional Commits:

feat: add per-second payment streaming
fix: handle wallet disconnect during session
docs: update Soroban contract README
test: add escrow settlement unit tests

Areas We Need Help

  • Stellar & Soroban smart contract development
  • Next.js / React frontend
  • Creator monetization UX
  • Testing and security review
  • Documentation

Communication

  • Open a GitHub Issue for bugs or feature requests
  • Use Discussions for questions
  • All communication should be friendly, inclusive, and constructive