Contributing¶
Working on mscompress. The repo has three buildable surfaces, all
backed by the same C core.
- Development setup — cmake, uv, npm
- Running tests — ctest, pytest, vitest
- Memory leak workflow — Valgrind and macOS
leaks - Versioning —
.cz.tomlandcz bump - CI overview — what the build matrix covers
Where things live¶
| Surface | Source | Tests |
|---|---|---|
| C core | src/, vendor/ |
— |
| CLI | cli/ |
cli/test/ (ctest) |
| Python | python/mscompress/ |
python/test/ (pytest) |
| Node.js | node-ts/src/ |
node-ts/test/ (vitest) |
| Electron app | electron/ |
— |
Adding an algorithm¶
See the implementer guide — touches
src/algos/, src/algo.c, src/mscompress.h, and adds tests in all
three test suites.