https://github.com/brennovich/cheat-ruby-sheets

One cheat sheet repo to rule them all
https://github.com/brennovich/cheat-ruby-sheets

Last synced: 3 months ago
JSON representation

One cheat sheet repo to rule them all

• Host: GitHub
• URL: https://github.com/brennovich/cheat-ruby-sheets
• Owner: brennovich
• Created: 2013-09-23T13:11:32.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2019-04-04T18:02:50.000Z (about 5 years ago)
• Last Synced: 2024-01-18T12:19:26.529Z (5 months ago)
• Size: 25.4 KB
• Stars: 112
• Watchers: 8
• Forks: 34
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Lists

• awesome-cheatsheet - ruby-cheat-sheet
• awesome-stars - brennovich/cheat-ruby-sheets - One cheat sheet repo to rule them all (Others)
• awesome-cheatsheet - ruby-cheat-sheet
• awesome-cheatsheet - ruby-cheat-sheet
• awesome-cheatsheet - ruby-cheat-sheet

README

        
# Cheat Ruby Sheets

One cheat sheet repo to rule them all.

## Collaborating

1. Fork

2. Create a feature-branch with the name of the thing that you are cheating

3. Follow the style conventions below

4. Pull Request

### Naming pattern

`gem_name.md` - Name of the cheatsheet for that gem. `gem_name` should be exactly

equals to the gem name in [Rubygems](http://rubygems.org/).

### Styles

Start your headings with `##` instead `#`:

**Right:**

## Styleguide

**Wrong:**

# Styleguide

When showing code describe the following line with comments:

```ruby

# Execute the given script, not returning a result. This is useful for scripts that return

# complex objects, such as jQuery statements. +execute_script+ should be used over

# +evaluate_script+ whenever possible.

page.execute_script("$('#change').text('Funky Doodle')")

```

If you wants to show the return of the current line, add `# =>` bellow of the code:

```ruby

page.evaluate_script("1+3")

# => 4

```

Respect the code indentation:

**Right:**

```ruby

within(search_form) do

  fill_in 'Name', with: 'iOS 7'

  click_button 'Search'

end

```

**Wrong:**

```ruby

    within(search_form) do

      fill_in 'Name', with: 'iOS 7'

      click_button 'Search'

    end

```

### To Do

- More, more and more cheat sheets

- Cool script to generate beautiful `.pdf` version of the `.md` versions