Contributing

Local hooks

Install pre-commit and enable the repository hooks:

pip install pre-commit
pre-commit install

Hooks run on each commit and enforce:

ABI snapshot hygiene (abis/*.json must change together with COMEBACKHERE-contracts/contracts/*/src/)
Markdown linting
Trailing whitespace detection
End-of-file fixing (ensure files end with a newline)
JSON validation

Run all hooks manually:

pre-commit run --all-files

The main branch is protected. Direct pushes are not allowed; all changes must go through a pull request.

All of the following checks must pass before a PR can be merged:

contract-build — Soroban contract compilation
contract-tests — contract unit and integration tests
abi-snapshot-hygiene — ABI metadata in abis/ is consistent with contract source
markdown-lint — documentation linting
frontend-build — frontend build succeeds

At least 1 approving review is required for all PRs.
At least 2 approving reviews are required for PRs that touch mainnet-related paths (docs/MAINNET_DEPLOYMENT.md, deployment scripts, or governance configuration).

After changing contract interfaces (in COMEBACKHERE-contracts/), regenerate and verify ABI metadata:

make update-abi-snapshots
# or
just snapshot

make check-abi-snapshots
# or
just check-snapshot