Contribute

Contribute to RevvFi

RevvFi is open source across all four repositories — contracts, backend, frontend, and docs. Code contributions, bug reports, and documentation fixes are all welcome.

github.com/RevvFi

All four repositories, issues, and pull requests

Repositories

revvfi-contracts

Solidity smart contracts (Foundry)

revvfi-backend

Go indexer and API

revvfi-app

Next.js frontend

revvfi-docs

Technical documentation

How to Submit a Change

  1. Fork the relevant repository and create a branch off main.
  2. Make your change. Keep pull requests focused on one thing — smaller PRs get reviewed faster.
  3. Run the test suite before opening a PR: forge test for contracts, go build ./... && go vet ./... && go test ./... for the backend, npx tsc --noEmit for the frontend.
  4. Open a pull request against main with a clear description of what changed and why.
  5. Be responsive to review feedback — most PRs need at least one round of changes.

Code Standards

  • Match the existing style and conventions of the file/repo you're editing rather than introducing a new pattern.
  • No hardcoded addresses, private keys, or magic numbers where an existing config/env pattern already exists.
  • Comments should explain non-obvious "why," not restate what the code already says.
  • Contract changes should come with tests covering the new behavior, not just the happy path.

Reporting Bugs

Open an issue on the relevant repository with steps to reproduce, what you expected, and what actually happened. For smart contract bugs, include the affected function and, if possible, a minimal Foundry test that reproduces the issue.

Security Issues

Do not open a public issue for a security vulnerability. See our Contact page and reach out directly instead.