Merge pull request #367 from 3scale/gitignore-and-asdf-instructions

Update .gitignore and development instructions
3scale · Mar 3, 2024 · 195793c · 195793c
2 parents 51825f1 + 332e4cc
commit 195793c
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 0 deletions.
diff --git 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
@@ -0,0 +1 @@
+ruby 3.0.2
diff --git 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