diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 71e81462e..7d5f58f6d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -78,6 +78,15 @@ an RFC or issue. project: one label, a request for the bug-report fields when a bug skipped the form, a registry lookup for linked Hugging Face models, and a pointer to Q&A for questions. The model only picks the label; every comment is a template. Maintainers can run it on any issue from the Actions tab. +- **A test runs only if a job builds it.** A ctest row is not enough. `ci.yml` builds a fixed `--target` list, so a + target that nothing builds never reaches ctest: hook it with `add_dependencies(onebit )`, the way + `onebit_npu_forward_syntax` is, and `tools/ci/ci_targets_check.py --check` keeps the count from growing. A + `tests/*.sh` script has to be named by a row — or listed with a reason in `tools/ci/unreferenced_tests.txt` if it is + not a row (`anchor_rerun.sh`, an operator measurement that always exits 0) — and `tools/ci/tests_referenced_check.py + --check` fails on one that is referenced by nothing. A row that runs Python goes through `add_python_test()`, which + hands the script to the interpreter instead of relying on the file's exec bit; `tests/python_test_order_check.py + --check` enforces that it follows `find_package(Python3)`. Two rows may not share a name: CMake stops at configure with + `add_test given test NAME "…" which already exists in this directory`. - **Pins only move forward.** CI fails a pull request whose submodule pin is behind, or has diverged from, the pin on `main` (`tools/check_pins.py`), because that drops commits the engine already shipped. A rollback on purpose carries the `pin rollback` label.