From d9d3eb63704649f71e348d3e2a9348b81e275353 Mon Sep 17 00:00:00 2001 From: Steven POST Date: Wed, 13 Mar 2024 14:04:32 +0100 Subject: [PATCH] Add missing command from CONTRIBUTING guide Running the rspec tests require first running the `spec_prep` rake command. This wasn't documented. An argument can be made for it being 'common knowledge', but that goes out the window with the 'all in one solution' for using bundler. --- moduleroot/.github/CONTRIBUTING.md.erb | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/moduleroot/.github/CONTRIBUTING.md.erb b/moduleroot/.github/CONTRIBUTING.md.erb index 88093274..02bb273d 100644 --- a/moduleroot/.github/CONTRIBUTING.md.erb +++ b/moduleroot/.github/CONTRIBUTING.md.erb @@ -163,6 +163,11 @@ environment variable: BUNDLE_JOBS="$(nproc)" ``` +Prepare to run tests: +```sh +bundle exec rake spec_prep +``` + ### Note for OS X users `nproc` isn't a valid command under OS x. As an alternative, you can do: