Railroady & Contributing to Open Source

Slide 1

Slide 1 text

RailRoady Gem & Contributing to Open Source kylie stradley @kyfast github.com/kyfast

Slide 2

Slide 2 text

who’s this lady? can she be trusted? Kylie Stradley Georgia Tech Grad Ruby on Rails Intern @ Big Nerd Ranch Cat owner

Slide 3

Slide 3 text

Trustworthy did not lie about the cat

Slide 4

Slide 4 text

–Preston Lee, maintainer of RailRoady RailRoady is a dirt simple gem for UML diagram generation on Rails 3/4 projects, capable of analyzing your existing models and controllers. It rocks!

Slide 5

Slide 5 text

Database Schema “Active Record knows how to update your schema, bringing it from whatever point it is in the history to the latest version. Active Record will also update your db/ schema.rb ﬁle to match the up-to-date structure of your database.”

Slide 6

Slide 6 text

Model Relationships

Slide 7

Slide 7 text

Controller Relationships

Slide 8

Slide 8 text

–Preston Lee, maintainer of RailRoady RailRoady is a dirt simple gem for UML diagram generation on Rails 3/4 projects, capable of analyzing your existing models and controllers. It rocks!

Slide 9

Slide 9 text

how to get RailRoady

Slide 10

Slide 10 text

What do I have now?

Slide 11

Slide 11 text

not so fast Currently, you need to manually create doc folder in application root folder Only available for Mac or Linux operating systems only for Rails 3 & 4, earlier Rails projects can use “RailRoad” gem

Slide 12

Slide 12 text

can be useful when… you’ve cobbled together Frankenstein’s monster of an app you’re new to an existing (& possibly complicated) app you’re just someone who likes diagrams

Slide 13

Slide 13 text

someone fixed it! Currently, you need to manually create doc folder in application root folder Only available for Mac or Linux operating systems only for Rails 3 & 4, earlier Rails projects can use “RailRoad” gem

Slide 14

Slide 14 text

It was me, It could be you too!

Slide 15

Slide 15 text

No content

Slide 16

Slide 16 text

If someone’s not already on it

Slide 17

Slide 17 text

check the issues

Slide 18

Slide 18 text

Fork it! & clone to your desktop

Slide 19

Slide 19 text

Fix & Push

Slide 20

Slide 20 text

Submit a Pull Request

Slide 21

Slide 21 text

Success!

Slide 22

Slide 22 text

any way you slice it get merged get rejected, but maybe they’ll tell you why maybe they’ll never look at it ever

Slide 23

Slide 23 text

Gem Source: https://github.com/preston/railroady ! Gem Documention: http://railroady.prestonlee.com/ ! Rails Documentation on Active Record(Slide 5): http://guides.rubyonrails.org/active_record_basics.html ! RailsCast on Contributing to Open Source: http://railscasts.com/episodes/300-contributing-to-open-source