Add CONTRIBUTING.md

mislav · Feb 26, 2020 · 59daa02 · 59daa02
1 parent 434b1b8
commit 59daa02
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,9 @@
+How to set up your environment for running tests:
+
+1. Run `script/bootstrap`
+
+   **Note:** on systems without Homebrew, you must ensure that MySQL 5.7, PostgreSQL 12, and MongoDB 4.x Community Edition are up and running.
+
+2. Run `script/test_all`
+
+   This ensures that the Active Record part of the suite is run across `sqlite3`, `mysql`/`mysql2`, and `postgres` database adapters.