Skip to main content

Contributing to Rheofi Protocol

Rheofi Protocol is open-source and welcomes contributions from the community. This guide covers how to set up your development environment, submit changes, and adhere to project coding standards.

Development Environment​

  1. Clone the repository and install dependencies:
git clone https://github.com/rheofi/protocol-contracts.git
cd protocol-contracts
yarn install
  1. Compile contracts:
npx hardhat compile
  1. Run tests:
npx hardhat test

The project uses Hardhat as its development framework, with Solidity ^0.8.20 as the target compiler version.

Pull Request Process​

  1. Fork the repository and create a feature branch from develop.
  2. Make your changes with clear, atomic commits.
  3. Ensure all existing tests pass and add new tests covering your changes.
  4. Run the linter and formatter before submitting:
yarn lint
yarn prettier:check
  1. Open a Pull Request against develop with a descriptive title and summary.
  2. A maintainer will review your PR. Address any feedback promptly.

Coding Standards​

  • Follow the Solidity Style Guide.
  • Use NatSpec comments (@notice, @param, @return) on all public and external functions.
  • Prefer custom errors over require strings for gas efficiency.
  • Keep functions short and single-purpose; extract shared logic into internal helpers.
  • All state-changing functions must emit events.
  • Use OpenZeppelin libraries for standard patterns (AccessControl, ReentrancyGuard, Pausable).

Reporting Issues​

If you discover a bug or security vulnerability, please open an issue on GitHub using the provided templates. For critical security issues, contact the team via the responsible disclosure process outlined in the repository's SECURITY.md.