Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (51 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

73 lines (51 loc) · 2.57 KB
Raw

Contributing to Finchippay-Solution

Thank you for your interest in contributing to Finchippay-Solution!

Getting Started

  1. Fork the repository at https://github.com/FinChippay/Finchippay-Solution
  2. Clone your fork: git clone https://github.com/<your-handle>/Finchippay-Solution.git
  3. Set up your local environment: bash scripts/setup-dev.sh
  4. Create a feature branch: git checkout -b feature/your-feature

Development Workflow

Running locally

# Backend
cd backend && cp .env.example .env && npm install && npm run dev

# Frontend (new terminal)
cd frontend && cp .env.example .env && npm install && npm run dev

# Smart contract
cd contracts/finchippay-contract && cargo test

Before opening a PR

Check Command
Backend lint cd backend && npm run lint
Backend tests cd backend && npm test
Frontend lint cd frontend && npm run lint
Frontend type-check cd frontend && npm run type-check
Frontend unit tests cd frontend && npm test
Contract tests cd contracts/finchippay-contract && cargo test

All checks must pass before a PR will be merged.

Commit Style

We use Conventional Commits:

feat: add streaming payment support
fix: handle zero-balance account on dashboard
docs: update API reference for /api/tips
test: add escrow cancel edge-case tests
chore: bump soroban-sdk to 21.0.0

Pull Request Guidelines

  • Keep PRs focused — one feature or bug-fix per PR.
  • Add or update tests for any new behaviour.
  • Update relevant docs and the CHANGELOG under [Unreleased].
  • Reference any related GitHub issues with Closes #<issue>.

Code Style

  • Rust (Soroban): rustfmt default style; clippy with --deny warnings. All arithmetic must use checked_* methods. Every mutating contract function must authenticate the caller with require_auth(). New features must include tests and consider bounds/limits to prevent griefing.
  • TypeScript/JavaScript: Prettier + ESLint (configs in repo root). Never log or commit Stellar secret keys. Use regex redaction (S[A-Z2-7]{55}) before any logging.
  • CSS: Tailwind utility classes; avoid custom CSS unless necessary.

Reporting Issues

Please use the GitHub issue templates:

License

By contributing you agree that your contributions will be licensed under the MIT License.