From 79391fae7375d6584a874fc0be425145944b3c17 Mon Sep 17 00:00:00 2001 From: Rachael Wright-Munn Date: Thu, 13 Jun 2024 15:27:39 +0000 Subject: [PATCH] Add info to CONTRIBUTING on how to setup the repo --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 56464819a8..857a7c3c2f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -66,3 +66,11 @@ Here are a few examples: [4]: https://help.github.com/articles/about-pull-requests [5]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html [6]: https://daringfireball.net/projects/markdown/syntax + +## Dev Environment Setup + +1. Ensure you have Ruby installed + - Add a .ruby-version file with the ruby version you'd like to test + - Install Ruby - `rbenv install` +1. Install dependencies - `bundle install` +1. Run the test cases to ensure your env is working - `bundle exec rake`