Skip to content

Repository files navigation

Contributing to USDAX Finance

Thank you for your interest in contributing. This document covers the basics for getting started.

Repositories

Repository Description
contracts Foundry/Solidity smart contracts
api Express REST API server
interface React web frontend

How to Contribute

  1. Fork the repository you want to contribute to
  2. Create a branch from main with a descriptive name
  3. Make your changes with clear, focused commits
  4. Open a pull request against main

Commit Messages

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.

Code Style

TypeScript (api, interface)

  • No implicit any
  • Prefer const over let
  • Follow existing file and folder structure

Solidity (contracts)

  • Foundry conventions
  • NatSpec comments on all public functions
  • forge test must pass before opening a PR

Security

Do not open public issues for security vulnerabilities. See SECURITY.md for the responsible disclosure process.

Contact

support@usdax.finance

About

USDAX Finance — CDP stablecoin protocol

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages