From 855c3a70e412eacd6efcaa3e95a36d9eeb3ff4cc Mon Sep 17 00:00:00 2001 From: Daniel Pietzsch Date: Wed, 22 Aug 2018 22:20:37 +0200 Subject: [PATCH] adding information to readme on how to set up the repository for development --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 70e7bbf..08932db 100644 --- a/README.md +++ b/README.md @@ -214,3 +214,21 @@ responsive_image: sizes: - ... ``` + +## Development + +If you'd like to contribute to this repository, here's how you can set it up for development: + +1. Fork this repository +2. Clone the fork to your local machine +3. Install [ImageMagick](http://www.imagemagick.org/) (if you haven't already) +4. Run `bundle install` +5. Run the tests like this: `cucumber` + +If you'd like your Jekyll project to use your local fork directly, you can add the `:path` parameter to your gem command in the project's Gemfile: + +```ruby +gem 'jekyll-responsive-image', :path => "/your/local/path/to/jekyll-responsive-image" +``` + +If you'd like your changes to be considered for the original repository, simply submit a pull request after you've made your changes. Please make sure all tests pass. \ No newline at end of file