sass-site/CONTRIBUTING.md

49 lines
1.3 KiB
Markdown
Raw Normal View History

2015-04-02 01:51:37 +02:00
Contributing to the Sass website
================================
**Please read the [Implementation Guide](http://sass-lang.com/implementation)**
2015-04-02 01:51:37 +02:00
The Sass website is open source. See a bug or typo? Have an idea? Just do the
following:
* Check out the style guide for design & code standards.
* Write a detailed description of what you're adding in the pull request
(screenshots help).
* Add any new UI elements to the style guide.
* Submit the pull request to the `master` branch.
* Drink whisky.
## Running Locally
This site is built with [middleman](http://middlemanapp.com), a Ruby framework
for building static sites.
You will need [Ruby](https://www.ruby-lang.org/en/downloads/),
[rubygems](http://rubygems.org/) and [bundler](http://bundler.io/) installed
before you can run the site locally.
If the above dependencies are installed, in your command line of preference,
navigate to the project repo and run:
```
bundle install
bundle exec rake import_sass
bundle exec middleman
```
## Deploying
If you're lucky enough to be one of our deployers, then just run the following
command from master branch... and MAKE SURE YOUR WORKING COPY IS CLEAN!
```
rake deploy
```
It's that easy.
If something goes wrong, make sure to run `rake clean`
Thanks!
2015-04-02 01:51:37 +02:00
— [Team Sass Design](http://twitter.com/teamsassdesign)