From cf2fb90bb0aef713ebed50c6c27e8d0325ba966d Mon Sep 17 00:00:00 2001 From: Moris Date: Fri, 7 Oct 2016 21:01:58 +0200 Subject: [PATCH 1/3] Added Contributing file with info --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..fb51c86 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +# Contributing + +Contributions are **welcome**! + +## Procedure 1 + +1. Create an [issue](https://github.com/una/CSSgram/issues) + +## Proedure 2 + +1. Fork this repository +2. Clone the fork onto your system +3. `npm install` dependencies (must have Node installed) +4. Run `gulp` to compile CSS and the test site +5. Make changes and check the test site with your changes (see file structure outline below) +6. Submit a PR referencing the issue with a smile :smile: + +Filters are really fun to create! Reference photos created by [Miles Croxford](https://twitter.com/milescroxford) can be found [here](https://instagram.com/cssgram/). \ No newline at end of file From 047d2dabd4bcf4a2d3f8df122adaed017f6bbd85 Mon Sep 17 00:00:00 2001 From: Moris Zen Pasic Date: Sun, 23 Oct 2016 11:48:27 +0200 Subject: [PATCH 2/3] Change contributing file according to request --- CONTRIBUTING.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fb51c86..a271bfc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,8 @@ Contributions are **welcome**! ## Procedure 1 -1. Create an [issue](https://github.com/una/CSSgram/issues) +1. Look if there is an existing [issue](https://github.com/una/CSSgram/issues) for your case. +2. If there isn't an existing issue, then create one. ## Proedure 2 @@ -12,7 +13,16 @@ Contributions are **welcome**! 2. Clone the fork onto your system 3. `npm install` dependencies (must have Node installed) 4. Run `gulp` to compile CSS and the test site -5. Make changes and check the test site with your changes (see file structure outline below) +5. Make changes (e.g. edit the .scss file related to the filter) and check the test site with your changes (see file structure outline below) 6. Submit a PR referencing the issue with a smile :smile: -Filters are really fun to create! Reference photos created by [Miles Croxford](https://twitter.com/milescroxford) can be found [here](https://instagram.com/cssgram/). \ No newline at end of file +Filters are really fun to create! Reference photos created by [Miles Croxford](https://twitter.com/milescroxford) can be found [here](https://instagram.com/cssgram/). + +## File Structure Outline + +- `source/css/cssgram.css` contains each of the CSS classes you can apply to your `` to give it the filter. You should use `source/css/cssgram.min.css` for production if you want access to all of the library +- `source/scss/` contains the source files for individual classes and placeholder selectors you can use to extend CSS classes in Sass +- `site/` is the public facing website +- `site/test` is how you test filters if you're developing, remember to change `is_done` for the filter you are creating in `site/filters.json`. + +Note: This will also have mixin options and a PostCSS Component. \ No newline at end of file From 9e32b4e1a63f7e3414a2e38116f43c0819b55948 Mon Sep 17 00:00:00 2001 From: Moris Zen Pasic Date: Mon, 31 Oct 2016 19:58:21 +0100 Subject: [PATCH 3/3] Updated with new gulp dev info --- CONTRIBUTING.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a271bfc..5abf6bf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,12 +7,15 @@ Contributions are **welcome**! 1. Look if there is an existing [issue](https://github.com/una/CSSgram/issues) for your case. 2. If there isn't an existing issue, then create one. -## Proedure 2 +## Procedure 2 1. Fork this repository 2. Clone the fork onto your system 3. `npm install` dependencies (must have Node installed) -4. Run `gulp` to compile CSS and the test site +4. Run `gulp` which starts dev server, watches and does compilations to .dev folder +**In master:** +**gulp build**: does compilation, files are generated in the respective folders +**gulp server**: starts server in root to view compiled files after master build 5. Make changes (e.g. edit the .scss file related to the filter) and check the test site with your changes (see file structure outline below) 6. Submit a PR referencing the issue with a smile :smile: @@ -25,4 +28,5 @@ Filters are really fun to create! Reference photos created by [Miles Croxford](h - `site/` is the public facing website - `site/test` is how you test filters if you're developing, remember to change `is_done` for the filter you are creating in `site/filters.json`. -Note: This will also have mixin options and a PostCSS Component. \ No newline at end of file +Note: This will also have mixin options and a PostCSS Component. +