Add CONTRIBUTING notes

panthomakos · Feb 12, 2024 · ebf1071 · ebf1071
1 parent 36fc3c6
commit ebf1071
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/CONTRIBUTING.markdown b/CONTRIBUTING.markdown
@@ -0,0 +1,6 @@
+# How to Contribute
+
+* Setup ruby and run `bundle` to install gems.
+* Ensure mysql is installed and started (example: `brew services start|stop mysql`).
+* Setup a MySQL user for testing (example: `mysql --user=root -e 'create user ${USER}@localhost'`).
+* Run tests w/ `bundle exec rake test`.