Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
176 lines (128 loc) · 4.94 KB

CONTRIBUTING.md

File metadata and controls

176 lines (128 loc) · 4.94 KB

🤝 Contributing to Harvest Finance

Thank you for helping empower smallholder farmers! This guide covers everything you need to contribute effectively.

📋 Table of Contents

Getting Started

1. Fork & Clone

git clone https://github.com/<your-username>/Harvest-Finance.git
cd Harvest-Finance

2. Setup Backend

cd harvest-finance/backend
npm install
cp .env.example .env   # fill in DB_HOST, DB_PASSWORD, JWT_SECRET, etc.
npm run migration:run
npm run start:dev       # runs on http://localhost:5000

3. Setup Frontend

cd harvest-finance/frontend
npm install
cp .env.example .env
npm run dev             # runs on http://localhost:3000

4. Setup Contracts (optional)

# Install Foundry: https://book.getfoundry.sh/getting-started/installation
cd contracts
forge install
forge test

Branch Naming

Type Pattern Example
Feature feat/<short-description> feat/login-page-ui
Bug fix fix/<short-description> fix/vault-deposit-overflow
Docs docs/<short-description> docs/api-readme
Refactor refactor/<short-description> refactor/vault-modular
Test test/<short-description> test/vault-edge-cases

Always branch off main unless the issue specifies otherwise.

Commit Messages

This project follows the Conventional Commits specification. Every commit message must use the format below so that changelogs can be generated automatically.

Format

<type>[optional scope]: <short description>

[optional body]

[optional footer(s)]
  • type — one of the allowed values listed below (lowercase, required)
  • scope — the area of the codebase affected, in parentheses, e.g. auth, vault, dto (optional)
  • short description — imperative, present tense, no trailing period, max 72 chars
  • body — free-form text explaining why the change was made (optional)
  • footer — BREAKING CHANGE: <description> or issue references such as Closes #123 (optional)

Allowed types

Type When to use
feat A new feature visible to users or API consumers
fix A bug fix
docs Documentation changes only
test Adding or updating tests, no production code change
refactor Code restructuring with no feature or bug-fix impact
chore Tooling, dependencies, config, CI — nothing that affects runtime
perf A change that improves performance
style Formatting, whitespace — no logic change
build Build system or external dependency updates
ci CI/CD configuration changes

Examples

feat(auth): add Stellar wallet login endpoint

fix(vault): correct totalDeposits drift on withdrawal

docs: update API README with state-sync endpoints

test(vault): add fuzz tests for VaultLib.toShares

refactor(vault): extract share math into VaultLib

chore: upgrade TypeORM to 0.3.28

feat(api)!: rename /deposits to /farm-vaults/deposits

BREAKING CHANGE: the /deposits route has been removed; update all clients to use /farm-vaults/deposits

Breaking changes

Append ! after the type/scope and add a BREAKING CHANGE: footer:

feat(api)!: rename deposit response fields

BREAKING CHANGE: `amount_deposited` is now `principal`; update all API clients accordingly

Reference the issue number in the PR description with Closes #<issue>.

Pull Request Workflow

  1. Claim the issue by commenting on it
  2. Create your branch from main
  3. Implement your changes with tests
  4. Run the test suite locally before pushing
  5. Open a PR against main with:
    • Clear title matching the issue
    • Description of what changed and why
    • Screenshots for UI changes
    • Closes #<issue-number>
  6. Address review feedback promptly

Coding Standards

TypeScript (Backend / Frontend)

  • Use async/await, not raw Promises
  • Validate all inputs with class-validator DTOs
  • Never return passwords or secrets in responses
  • Use NestJS guards for all protected routes

Solidity (Contracts)

  • Follow Checks-Effects-Interactions
  • Use ReentrancyGuard on all state-mutating functions
  • Add NatSpec (@notice, @param, @return) to all public functions
  • Prefer libraries for reusable pure math

Testing Requirements

Layer Minimum Coverage Command
Backend unit ≥ 90% npm run test:cov
Backend e2e Key flows npm run test:e2e
Contracts fuzz 10,000 runs forge test
  • All PRs must pass CI before merge
  • New features must include corresponding tests
  • Bug fixes must include a regression test