Skip to content
This repository has been archived by the owner on Apr 12, 2024. It is now read-only.

Latest commit

 

History

History
36 lines (27 loc) · 1.25 KB

ruby.md

File metadata and controls

36 lines (27 loc) · 1.25 KB
title sidenav sticky_sidenav
Ruby Guide
languages
true

Help us make this section better by submitting an issue or joining us in the #ruby channel!

A guide for writing and maintaining Ruby and Rails applications

Style Guide

Follow the Ruby Style Guide and enforce it via static analysis tools such as Code Climate and Rubocop. You can copy the recommended Rubocop configuration in your Ruby project and make any changes based on your team's preferences.

Note that the Rubocop configuration linked above only includes settings that differ from the default configuration. We tend to agree with most of the default settings.

Whenever a Style Rubocop setting provides multiple options, at least one option must be chosen. A cop that supports different styles must never be disabled outright. The point is to pick one style and use it consistently.

Testing

Validating HTML output

We use HTMLProofer for testing rendered HTML automatically. Please see the test page for more details.