Skip to content

Add improvements to styleguide #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Aug 30, 2022
Merged

Add improvements to styleguide #113

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9e4d478
Display testing commands on separate lines
elenatanasoiu Aug 28, 2022
5622c35
Add table of contents
elenatanasoiu Aug 28, 2022
50f9b94
Point to Rubocop guide
elenatanasoiu Aug 28, 2022
2bda235
Re-organise "Coding Style" section
elenatanasoiu Aug 28, 2022
fe295a7
Extract method-related rules into own section
elenatanasoiu Aug 28, 2022
839223d
Extract "Conditional Expressions" section
elenatanasoiu Aug 28, 2022
653e004
Add handy anchor links to items in styleguide
elenatanasoiu Aug 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add table of contents
  • Loading branch information
@elenatanasoiu
elenatanasoiu committed Aug 28, 2022
commit 5622c35630e2f354101bee707424d316fd198abb
18 changes: 18 additions & 0 deletions STYLEGUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# Ruby Style Guide

## Table of Contents
1. [Coding Style](#coding-style)
2. [Classes](#classes)
3. [Collections](#collections)
4. [Documentation](#documentation)
5. [Dynamic Dispatch](#dynamic-dispatch)
6. [Exceptions](#exceptions)
7. [Hashes](#hashes)
8. [Keyword Arguments](#keyword-arguments)
9. [Naming](#naming)
10. [Percent Literals](#percent-literals)
11. [Regular Expressions](#regular-expressions)
12. [Requires](#requires)
13. [Strings](#strings)
14. [Syntax](#syntax)

## Coding Style

* Use soft-tabs with a two space indent.

* Keep each line of code to a readable length. Unless you have a reason to, keep lines to a maximum of 118 characters. Why 118? That's the width at which the pull request diff UI needs horizontal scrolling (making pull requests harder to review).
Expand Down
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy