Contribution guide

Author: FooBarWidget

CONTRIBUTING.md

@@ -0,0 +1,16 @@
+# Contribution guide
+
+## Running tests
+
+To run the test suite, you need a Google Cloud Storage bucket and a Service Account with a key. You must also set the following environment variables:
+
+ * `TEST_GCLOUD_BUCKET` — the name of the bucket.
+ * `TEST_GCLOUD_CREDENTIALS_PATH` — path to the Service Account's keyfile.
+
+It's best to put these in a `.env` file so that you don't have to supply these variables over and over. The test suite automatically loads environment variables from `.env`.
+
+Then run the test suite with:
+
+~~~bash
+bundle exec rspec
+~~~

README.md

@@ -154,3 +154,7 @@ DistributedLock::GoogleCloudStorage::Lock(
   logger: logger,
 )
 ~~~
+
+## Contributing
+
+Please read the [Contribution guide](CONTRIBUTING.md).

spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dotenv'
 require 'google/cloud/errors'
 require 'rspec/retry'