Skip to content

thenerdery/ruby-standards

Repository files navigation

layout title author
page
README
The Nerdery Ruby Standards Task Force

Introduction

This small Jekyll-based site houses the Ruby Standards used by developers at The Nerdery. If you're a Nerdery developer, you should totally know these standards by heart. If not? This is a great place to learn some (at least we think) awesome best practices.

Contributing

There's two ways you can contribute to this repository:

  1. Get access from @sumpygump, create a branch and issue a Pull Request.
  2. Make a fork and then issue a Pull Request

We can actually discuss your PR and decide if we want to pull it into our main standards or not, so don't be shy.

Project Structure

  |
  |- index.md              - the main standards document
  |- _sass                 - where the sass lives
  |- _layouts/default.html - the main page wrapper
  |- _layouts/page.html    - the main layout for the standards document

Getting Started

You will need Ruby installed and properly functioning for this Jekyll site to run locally. If you don't already, you can certainly consult this guide to get it installed properly.

bundle install
bundle exec jekyll serve

After that, the site will be running @ http://localhost:4000 and sports live-reloading as you make changes.

Installation Troubleshooting

If you run into an error on Mac OS X after running bundle install regarding an error for nokogiri. The following steps may allow you to get the dependencies installed properly, as per this stackoverflow post.

brew uninstall --force xz
gem install nokogiri -v 1.6.8
bundle config build.nokogiri --use-system-libraries

Releases

No releases published

Packages

No packages published