Contributing - Shopify/shopify_transporter GitHub Wiki

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Pull Request Process

  1. Ensure that all code you are adding is described by unit tests.
  2. Ensure the code in the pull request passes linting, and that all the unit tests pass.
  3. Request reviews from at least two of the owners of the repository.

Running unit tests

Our test suite is written using RSpec. To run all the tests:

bundle exec rspec

Running the linter

We use Rubocop to keep our code clean and consistent. It's important that our entire codebase satisfies our linting rules. To run the linter manually:

bundle exec rubocop

To automatically resolve any basic linting issues, you can run:

bundle exec rubocop -a

Building and installing locally

To build locally run the following command:

$ bundle exec rake build

shopify_transporter 1.0.0 built to pkg/shopify_transporter-1.0.0.gem.

Then, you can install the gem system-wide by running:

$ gem install pkg/shopify_transporter-1.0.0.gem

Successfully installed shopify_transporter-1.0.0
Parsing documentation for shopify_transporter-1.0.0
Installing ri documentation for shopify_transporter-1.0.0
Done installing documentation for shopify_transporter after 0 seconds
1 gem installed

Your locally built gem is now installed system-wide.