CONTRIBUTING

tcmts.CONTRIBUTING · #tacn3i6l · md file

Contributing

tcm is developed in tcm, so there are no source files here to change: this repository only says how to get tcm's codebase. A change is a contribution, proposed on tcm's server and reviewed there as definitions, as on Unison Share. The whole guide is contributing; in short:

git clone https://github.com/hipstersmoothie/tcm-ts && cd tcm-ts
pnpm tcm status                    # gets tcm and its codebase (into codebase/; no token needed to read)
pnpm tcm remote add origin https://tcm.codes --token <your token>
pnpm tcm branch my-change && pnpm tcm switch my-change
# … change it (pnpm tcm patch, or edit and update; an agent works through .mcp.json and AGENTS.md)
TCM_BRANCH=my-change pnpm verify   # everything a change needs (verify reads main unless told)
pnpm tcm contribute --title "What it does" --description "Why"

More: developing tcm-ts · contributions · AGENTS.md