mirror of
https://github.com/danog/sass-site.git
synced 2024-12-03 09:57:58 +01:00
35 lines
949 B
Markdown
35 lines
949 B
Markdown
|
Contributing to the Sass website
|
||
|
|
================================
|
||
|
|
|
||
|
|
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
|
||
|
|
middleman
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
Thanks!
|
||
|
|
|
||
|
|
— [Team Sass Design](http://twitter.com/teamsassdesign)
|