diff --git a/.gitignore b/.gitignore index 36fc4ea4..ff1d1371 100644 --- a/.gitignore +++ b/.gitignore @@ -18,3 +18,11 @@ bench.txt 3scale_backend.sock .env +/tmp + +# JetBrains IDE +/.idea +/.run + +# asdf +.tool-versions diff --git a/.tool-versions.sample b/.tool-versions.sample new file mode 100644 index 00000000..a2e77829 --- /dev/null +++ b/.tool-versions.sample @@ -0,0 +1 @@ +ruby 3.0.2 diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index d6202be7..fce2c3b0 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -14,6 +14,16 @@ The first thing you will need is cloning the project: Next cd into the directory, `cd apisonator`. +### Ruby version management + +In order to manage Ruby versions for local development, we recommend using [asdf](https://asdf-vm.com/guide/getting-started.html). + +Once installed, use the provided `.tool-versions.sample` file to get the appropriate versions. + +``` +cp .tool-versions.sample .tool-versions +``` + ### Containerized environment #### With Docker