From 89560c16a6d0b4d51e75069f61445aa90ff3fab5 Mon Sep 17 00:00:00 2001 From: Richard Levasseur Date: Sun, 6 Jul 2025 15:52:56 -0700 Subject: [PATCH] docs: add whl_from_dir to dev guide docs --- CONTRIBUTING.md | 4 +++- docs/devguide.md | 12 ++++++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8f985c551b..e1bd11b81d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -234,11 +234,13 @@ merged: ## Binary artifacts Checking in binary artifacts is not allowed. This is because they are extremely -problematic to verify and ensure they're safe +problematic to verify and ensure they're safe. This is true even in +test contexts. Examples include, but aren't limited to: prebuilt binaries, shared libraries, zip files, or wheels. +See the dev guide for utilities to help with testing. (breaking-changes)= ## Breaking Changes diff --git a/docs/devguide.md b/docs/devguide.md index 345907b374..43120bf2a1 100644 --- a/docs/devguide.md +++ b/docs/devguide.md @@ -37,6 +37,12 @@ to be perfectly factored and not every common thing a test does needs to be factored into a more generally reusable piece. Copying and pasting is fine. It's more important for tests to balance understandability and maintainability. +### Test utilities + +General code to support testing is in {gh-path}`tests/support`. It has a variety +of functions, constants, rules etc, to make testing easier. Below are some +common utilities that are frequently used. + ### sh_py_run_test The {gh-path}`sh_py_run_test