Thank you for your interest in contributing. This document covers the basics for getting started.
| Repository | Description |
|---|---|
| contracts | Foundry/Solidity smart contracts |
| api | Express REST API server |
| interface | React web frontend |
- Fork the repository you want to contribute to
- Create a branch from
mainwith a descriptive name - Make your changes with clear, focused commits
- Open a pull request against
main
Use the conventional commits format:
feat: add X
fix: correct Y
docs: update Z
chore: bump dependency
No special characters in commit messages. Keep subject lines under 72 characters.
TypeScript (api, interface)
- No implicit
any - Prefer
constoverlet - Follow existing file and folder structure
Solidity (contracts)
- Foundry conventions
- NatSpec comments on all public functions
forge testmust pass before opening a PR
Do not open public issues for security vulnerabilities. See SECURITY.md for the responsible disclosure process.