From 7dc65b2d9873b6bbb6ef90234b3db6546e4ed9af Mon Sep 17 00:00:00 2001 From: bpatel347 Date: Mon, 11 Nov 2024 15:29:25 -0500 Subject: [PATCH] docs/contributing: update documentation for running single tests docs/contributing: update documentation for running single tests docs/contributing: update documentation for running single tests --- CONTRIBUTING.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fa17350d..c3e6ea4b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -104,7 +104,13 @@ You can specify the special `test` attribute in the configuration that will not - `test.runNvim`: Set to `false` to avoid launching nvim with this configuration and simply build the configuration. -The tests are then runnable with `nix flake check --all-systems`. +> [!TIP] +> A single test can be run with `nix develop --command tests --interactive`. This launches the testing suite in interactive mode, allowing you to easily search for and select specific tests to run. + +> [!WARNING] +> Running the entire test suite locally is not necessary in most cases. Instead, you may find it more efficient to focus on specific tests relevant to your changes, as Continuous Integration (CI) will run the full test suite on any Pull Requests (PRs) you open. This ensures comprehensive coverage without requiring the full suite to be run locally every time. + +The full test suite can still be run locally with `nix flake check --all-systems` if needed. There are a second set of tests, unit tests for nixvim itself, defined in `tests/lib-tests.nix` that use the `pkgs.lib.runTests` framework.