sass-site/CONTRIBUTING.md
2022-10-13 10:26:33 -07:00

1.3 KiB

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 and the Style Guide 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 main branch.
  • Drink whisky.

Running Locally

This site is built with middleman, a Ruby framework for building static sites.

You will need Ruby, rubygems 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
bundle exec rake sass:import
bundle exec middleman

Deploying

Every time a new commit is pushed to main, it will automatically be deployed to sass-lang.com. Easy as that!

Thanks!

— Sass Core Team