Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (47 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

64 lines (47 loc) · 2.21 KB

Contributing to create-protocol/token-simulator

This repo holds Create Protocol scenarios for the kcolbchain/token-simulator engine. Contributions here are typically new scenario YAMLs, parameter sweeps, or corrections to existing assumptions.

Ground rules

  • Every number has a source. Either a citation (doc link, on-chain query, vendor quote) or an explicit TODO: marking it as a placeholder. "Looks about right" is not a source.
  • No engine code here. Engine bugs, new math, Monte Carlo primitives — those go to kcolbchain/token-simulator. If you need a new engine feature to express your scenario, open an issue there and link it from your scenario PR.
  • Scenarios are immutable once released. If you want to change assumptions, copy the file and bump the version (v1 → v2) so past analyses remain reproducible.

Picking something to work on

  1. Browse issues labeled good first issue or help wanted.
  2. Comment on the issue to claim it.
  3. Open a draft PR with your YAML + a short description of what it models and where the numbers came from.

Scenario schema

Every scenario file lives under scenarios/ and must include:

  • scenario.id — unique slug, matches the filename
  • scenario.version — integer, bumped on every breaking change
  • scenario.horizon_months — simulation horizon
  • token.fixed_supply — even if token isn't active, keep the constant
  • revenue_streams[] — at least one, each with a take_rate_bps and a growth model
  • costs — at minimum infra + team
  • outputs.track — list of metrics the engine should emit

If the engine adds a new top-level key, document it here.

Local check

Until the engine publishes validation:

python -c "import yaml; yaml.safe_load(open('scenarios/YOUR_FILE.yaml'))"

Commits

Conventional Commits:

feat(scenario): add Phase 2 compute-stream preset
fix(burn-toll): correct toll destination to treasury burn
docs(readme): clarify engine/scenario split

— kcolbchain / Abhishek Krishna