Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (25 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

34 lines (25 loc) · 1.19 KB
Raw

Contributing

Thank you for your interest in contributing! This repository hosts the ROFL Accounting Module: on-chain contracts in solidity/ and the Python service in src/ that runs in Oasis ROFL TEE.

Getting started

  • Python service: see src/README.md. The project uses uv for dependency management and pytest for tests.
  • Contracts: see solidity/README.md. The project uses Hardhat with bun for dependency management.

Before opening a pull request

  • Install the pre-commit hooks and make sure they pass:

    pre-commit install
pre-commit run --all-files

  • Run the relevant test suites (pytest for Python, bun hardhat test in solidity/ for contracts).

  • Keep pull requests focused; separate refactors from behavior changes.

  • Use descriptive commit messages with a component prefix, e.g. solidity: ..., api: ..., rofl: ..., matching the existing history.

Reporting issues

Bug reports and feature requests are welcome via GitHub issues. For anything security-sensitive, please follow SECURITY.md instead of opening a public issue.