From 5e722dd42827712948d9bff74a5e0e39d715fcf9 Mon Sep 17 00:00:00 2001 From: spencerking Date: Fri, 21 Oct 2016 18:22:49 -0500 Subject: [PATCH 1/3] starting a contributing.md file --- CONTRIBUTING.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3cd9f41 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# How to contribute + +## Getting Started + +Either: + +1. Create an [issue](https://github.com/una/CSSgram/issues) + +Or: + +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/). + From cf23f55d140035813997a7842cf7ff8e619bc76c Mon Sep 17 00:00:00 2001 From: spencerking Date: Sun, 30 Oct 2016 11:29:56 -0500 Subject: [PATCH 2/3] writing CONTRIBUTING --- CONTRIBUTING.md | 6 +++++- README.md | 15 +-------------- 2 files changed, 6 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3cd9f41..0f88a20 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,8 +12,12 @@ Or: 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 and check the test site with your changes (see file structure outline on the README) 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/). + +## What to Commit + +When committing please ignore the built CSS files. Only commit the updated scss and data files. diff --git a/README.md b/README.md index 256f18d..4e41cf2 100644 --- a/README.md +++ b/README.md @@ -175,20 +175,7 @@ _For use in Sass stylesheets:_ ## Contributing -Either: - -1. Create an [issue](https://github.com/una/CSSgram/issues) - -Or: - -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/). +Please start by reading our [CONTRIBUTING](CSSgram/blob/master/CONTRIBUTING.md) file. ## File Structure Outline From 5e6c8d6ae205d3da0591cc9dd70641b179a00191 Mon Sep 17 00:00:00 2001 From: spencerking Date: Sun, 30 Oct 2016 11:39:34 -0500 Subject: [PATCH 3/3] added node installation steps --- CONTRIBUTING.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0f88a20..f2bbc40 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Either: -1. Create an [issue](https://github.com/una/CSSgram/issues) +1. Create an [issue](https://github.com/una/CSSgram/issues) if one does not already exist. Or: @@ -17,6 +17,19 @@ Or: Filters are really fun to create! Reference photos created by [Miles Croxford](https://twitter.com/milescroxford) can be found [here](https://instagram.com/cssgram/). +## Installing Node + +If you do not have Node installed please follow these steps for your system: + +### Mac +Make sure you have XCode and Homebrew installed and run 'brew install node' + +### Windows +It is easiest to download the installer from the [nodejs.org](https://nodejs.org/en/#download) website. + +### Linux +Instructions may vary depending on your distribution, found [here](https://nodejs.org/en/download/package-manager/) + ## What to Commit