Skip to content

Development

m4bwav edited this page Nov 7, 2026 · 3 revisions

Agent rules are in AGENTS.md, and the file map in CODEMAP.md.

Commands

Run from the repository root:

python -m unittest discover -s tests
python scripts/budget.py
python scripts/calibrate.py <folder of audio>

At 0.1.8 the suite ran 38 tests, all passing, and the budget was green.

CI (.github/workflows/tests.yml) runs the tests on Ubuntu, macOS and Windows on Python 3.9 and 3.14, without Ubuntu on 3.9, and fails on a red size budget.

Rules that shape changes

  • Standard library only, Python 3.9 or later. ffmpeg stays optional. Every change gets a test.
  • sounds.json changes only with a schema bump.
  • Thresholds change only with a calibration note. A heuristic is never a verdict.
  • The repository is public: no private names, hostnames, paths or lab audio, and audio only with clear rights.
  • No copies of sounds from named films and no famous sound marks, in prompts, evals or samples.

Releasing

A release bumps .claude-plugin/plugin.json, plugin.json, VERSION in sfx.py, metadata.version in SKILL.md and the changelog together. tests/test_version.py is in the suite.

How this wiki's output was made

_verify/wiki-verify.py in this wiki's git repository runs every command shown here, and _verify/wiki-verify.out.txt is its saved output. To update, clone https://github.com/m4bwav/sfxwright.wiki.git, run the script against the new version, and compare.

Clone this wiki locally