Contributing documentation

[anthonydillon]

I would like to contribute to this project but there is a lack of documentation detailing how to run, test and demo the changes. Please, could you add some basic steps to get the grid running and how to view changes locally.

[petebrowne]

Thanks for bringing this up. Previously I tested against the demo site itself, but that's a bit cumbersome and not currently a public repo (though I think it could be).

Developing a simple demo inside this project, along with a way to verify changes is a great idea. I'm open to suggestions on the best way to accomplish that

[anthonydillon]

It would be a start by hard coding a demo.html file with a bunch of examples of the grid simply importing the grids locally generated css. So when someone builds the scss they can check the demo to see if it fixed what then thought it should fix and that nothing else is broke with a glance of a page.

The other thing that would be nice would be to have brief instructions on building the grid locally in the readme, contributing or even just a hacking document.

What do you think?

[petebrowne]

Quick update: I didn't forget about this. I started setting up a demo for testing this weekend

[anthonydillon]

Good stuff, I also was going to create a simply HTML page to test but didn't find the time. Do you have the install and run commands handy?

…

On Mon, 6 Feb 2017 at 16:04 Pete Browne ***@***.***> wrote: Quick update: I didn't forget about this. I started setting up a demo for testing this weekend — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#6 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABWRniA5QoIe6Evc_fBVFKCdHOc-TFU_ks5rZ0SlgaJpZM4Lyh92> .

[petebrowne]

I'm in the process of adding a Gulpfile for watching/testing. Using the current setup, which is setup with Ruby:

# Install ruby dependencies
bundle install
# Regenerate the CSS file `css/shelves.css`
rake generate

[petebrowne]

I created a PR for adding the Demo server - if you don't mind, can you take a quick look and tell me if this is helpful?