Skip to content

Improving contributing information #269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
spencerking wants to merge 4 commits into from
Closed

Improving contributing information #269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
da00301
Merge remote-tracking branch 'una/master'
spencerking Oct 21, 2016
5e722dd
starting a contributing.md file
spencerking Oct 21, 2016
cf23f55
writing CONTRIBUTING
spencerking Oct 30, 2016
5e6c8d6
added node installation steps
spencerking Oct 30, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# How to contribute

## Getting Started

Either:

1. Create an [issue](https://github.com/una/CSSgram/issues) if one does not already exist.

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 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/).

## 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

When committing please ignore the built CSS files. Only commit the updated scss and data files.
15 changes: 1 addition & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down