sass-site/CONTRIBUTING.md

48 lines
1.3 KiB
Markdown
Raw Normal View History

2015-04-02 01:51:37 +02:00
Contributing to the Sass website
================================
The Sass website is open source. See a bug or typo? Have an idea? Do the
following:
* **Please read the [Implementation Guide][sg] and the [Style Guide][sg]**
before contributing.
* Write a detailed description of what you're adding in the pull request
(screenshots help).
* If there is new design or CSS, please add @Jina as a reviewer so she can see
if it needs to be added to the style guide (or if a suitable alternative
exists).
* Submit the pull request to the `master` branch.
* Drink whisky.
## Running Locally
This site is built with [middleman][], a Ruby framework for building static
sites.
You will need [Ruby][], [rubygems](http://rubygems.org/) and [bundler][]
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
2018-03-10 00:32:48 +01:00
bundle exec rake sass:import
bundle exec middleman
```
## Deploying
Every time a new commit is pushed to master, it will automatically be deployed
to sass-lang.com. Easy as that!
Thanks!
2018-10-22 23:13:05 +02:00
— Sass Core Team
[ig]: http://sass-lang.com/implementation
[sg]: http://sass-lang.com/styleguide
[middleman]: http://middlemanapp.com
[ruby]: https://www.ruby-lang.org/en/downloads/
[bundler]: http://bundler.io/