39 lines (27 loc) · 1.16 KB

Contributing Workflow

This repo may be used both as a research workspace and as a software project, so the safest workflow is a small, verifiable change loop.

Suggested flow

identify the subsystem you are changing
inspect the current docs and nearby tests
make the smallest change that solves the problem
run the narrowest relevant verification first
update docs if commands, paths, or outputs changed
run a broader verification pass before handoff

By area

Dataset or manifest changes

validate sample manifests
check path conventions
update docs/guides/datasets.md if the user workflow changed

Training or evaluation changes

run affected unit tests
verify --help output still makes sense
update docs/guides/models.md and docs/guides/benchmarks.md if flags or outputs moved

Android changes

run Kotlin unit tests when possible
build a debug APK
update docs/guides/android.md or architecture/API docs if subsystem behavior changed

Handoff checklist

changed commands are documented
new files or outputs are mentioned where users will look for them
broken placeholders are removed instead of left behind