From ebf1071c69f5855f5660b173f1dd6407ba26a391 Mon Sep 17 00:00:00 2001 From: Pan Thomakos Date: Mon, 12 Feb 2024 09:43:54 -0800 Subject: [PATCH] Add CONTRIBUTING notes --- CONTRIBUTING.markdown | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 CONTRIBUTING.markdown diff --git a/CONTRIBUTING.markdown b/CONTRIBUTING.markdown new file mode 100644 index 0000000..9cd7e8e --- /dev/null +++ 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`.