danog/sass-site
1
0
Fork 0
mirror of https://github.com/danog/sass-site.git synced 2025-01-21 21:31:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

Move contributing info to CONTRIBUTING.txt

Browse Source
This commit is contained in:
Jina Bolton 2014-04-19 15:31:20 -07:00
parent 785ba94477
commit 1319d2c4c0
3 changed files with 39 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -13,6 +13,7 @@
# Ignore bundler config
/.bundle
bundle/
.bundle
# Ignore rbenv local .ruby-version file

34
CONTRIBUTING.txt Normal file
View File

@ -0,0 +1,34 @@
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)

36
README.md
View File

@ -1,35 +1,7 @@
# sass-lang.com
## Contributing
The Sass website is open source. See a typo? Have a UX improvement? Check out
the CONTRIBUTING.txt!
If you would like to contribute to the Sass website, please do the following:
* Check out the [style guide](http://sass-lang.com/styleguide) 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.
* 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)
* [Sass website Style Guide](http://sass-lang.com/styleguide)
* [@TeamSassDesign](http://twitter.com/teamsassdesign)