Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
Open Source Maintenance — RailsClub Moscow
Search
Eric Hodel
September 28, 2013
Programming
1
140
Open Source Maintenance — RailsClub Moscow
Presented at RailsClub Moscow 2013
Eric Hodel
September 28, 2013
Tweet
Share
More Decks by Eric Hodel
See All by Eric Hodel
Building maintainable command-line tools with MRuby
drbrain
0
600
Introduction to Rake
drbrain
0
290
Lazy Enumeration
drbrain
0
110
Lessons in Mentorship
drbrain
1
180
Open Source Maintenance — Ruby on Ales 2014
drbrain
1
95
drbdump
drbrain
2
460
Other Decks in Programming
See All in Programming
JAWS Days 2025のインフラ
komakichi
1
200
新宿駅構内を三人称視点で探索してみる
satoshi7190
2
120
Swift Testingのモチベを上げたい
stoticdev
2
190
AIプログラミング雑キャッチアップ
yuheinakasaka
19
5k
SwiftUI移行のためのインプレッショントラッキング基盤の構築
kokihirokawa
0
170
Expoによるアプリ開発の現在地とReact Server Componentsが切り開く未来
yukukotani
1
200
Lambdaの監視、できてますか?Datadogを用いてLambdaを見守ろう
nealle
2
720
CDK開発におけるコーディング規約の運用
yamanashi_ren01
2
260
Webフレームワークとともに利用するWeb components / JSConf.jp おかわり
spring_raining
1
130
The Clean ArchitectureがWebフロントエンドでしっくりこないのは何故か / Why The Clean Architecture does not fit with Web Frontend
twada
PRO
48
15k
pylint custom ruleで始めるレビュー自動化
shogoujiie
0
160
未経験でSRE、はじめました! 組織を支える役割と軌跡
curekoshimizu
1
200
Featured
See All Featured
Easily Structure & Communicate Ideas using Wireframe
afnizarnur
193
16k
[Rails World 2023 - Day 1 Closing Keynote] - The Magic of Rails
eileencodes
33
2.1k
What’s in a name? Adding method to the madness
productmarketing
PRO
22
3.3k
Documentation Writing (for coders)
carmenintech
68
4.6k
Navigating Team Friction
lara
183
15k
The Power of CSS Pseudo Elements
geoffreycrofte
75
5.5k
The Art of Programming - Codeland 2020
erikaheidi
53
13k
Producing Creativity
orderedlist
PRO
344
40k
Designing Experiences People Love
moore
140
23k
Thoughts on Productivity
jonyablonski
69
4.5k
Build your cross-platform service in a week with App Engine
jlugia
229
18k
Fantastic passwords and where to find them - at NoRuKo
philnash
51
3k
Transcript
Open Source Maintenance Eric Hodel - drbrain@segment7.net
Open Source is My Job
Projects •RubyGems •RDoc •net-http-persistent •… many more
Responsibilities Maintenance Stewardship Understanding
Why Open Source?
“programming is rather thankless. you see your works become replaced
by superior works in a year. unable to run at all in a few more.” _why
“Here’s what becoming eFamous made me realize: Everyone is sincere
and doing it because they care. I was very surprised to learn this.” @garybernhardt
“I get paid to do something I love. Something I’ve
done in my spare time since I was a kid. That’s awesome. That’s why I care.” @lindseybieda
I Care
Pleasant Surprises net-http-persistent single connection ~750,000 requests
Pleasant Surprises rdoc -C shows documentation coverage for your library
used in contracts
Values
Open Source Values •Community •Collaboration •Sharing •Re-use
Proprietary Software “Your team should work like an open source
project” bit.ly/1byoEiK Ryan Tomayko
OSS Constraints •Electronic Communication •Visible Work •Asynchronous •Lock-free
Commits
Commits Create History
Tell a Story
Commit Small •History is easier to read •Easy to revert
•Easy branch maintenance •github user page bragging
Atomic Commit Convention bit.ly/160ia91
Small Commits •Fix only one bug •Add one method •Whitespace
cleanup •Reformat a line
Current status: Not sure where I was going with this
“One thing Clojure has taught me is that good commit
messages are a luxury of people that know what […] they are doing” @tpope
Be Descriptive Descriptive messages make history easy to understand
git commit --help “begin the commit message with a single
short line summarizing the change”
Short Summary •The URI argument to Gem::Request.new must be a
URI •Only display relevant release notes upon update •Allow `gem uninstall foo --all`
git commit --help “followed by a more thorough description”
Thorough Description The URI argument to Gem::Request.new must be a
URI The tests were lazy and used a String which was converted internally. This causes problems on older ruby versions which don't allow `URI(URI("http://example"))`. Now the argument given is always a URI in the tests.
Thorough Description •Old behavior •Why it needs to change •New
behavior
Thorough Description •Commit references •Issue references •Don't assign blame •Except
to yourself
Issues
Organize
Issue Labels •Status •Type •Category
Milestones •Release boundary •Allow slippage •Feature freeze
Keep an Open Mind
Random Test Failure -{"SHA512"=> +{"SHA1"=>
Random Test Failure •Rarely occurs •Probably hash order problem •Must
be hash order problem!
Hash Mismatch +"data.tar.gz"=>"14413052..."}, -"data.tar.gz"=>"c6465bbb..."},
gzip Timestamp •One second resolution •Test gzipped two files •Sometimes
in different seconds
It's OK to Be Wrong
rubygems/rubygems #510 them: The chmod should be included in the
publishing guide
rubygems/rubygems #510 me: Why? The file is created with the
correct permissions
rubygems/rubygems #510 them: The guide says to run: curl -u
username [...] > ~/.gem/credentials
rubygems/rubygems #510 me: I'm sorry, I didn't read that section.
RubyGems creates the credentials file for you. I'll rewrite the offending section.
Pursue Understanding
“‘X’ is Hard to Use” •“Hard”, “Broken”, “Doesn't Work” •You
think “X” is easy, works •They might be right!
Maintenance & New Features
Find the Root Cause
“Trying to force myself to keep asking, ‘rather than *solve*
[hard problem X], is there a way to make [X] irrelevant?’ Typical answer: yes.” Kathy Sierra — @seriouspony
Hard → Easy •Hide details when possible •Avoid configuration •Provide
broad defaults
“The worst thing about writing clever code is not being
clever enough to understand it.” Eleanor McHugh — @feyeleanor
Keep it Simple •Small commits •Minimum change •Document when you
can't
rails/rails@ba0568e “In the past we used Hash[columns.zip(row)] […], the verbose
way is much more efficient both time and memory wise cause it avoids a big array allocation”
Refactor •Simplify methods •Improve API •Improve understanding •Don't forget tests
Good API
Compact API •Minimum objects •Minimum arguments •Minimum configuration •Self-check through
tests
Good Names •Hardest •Do your names fit? •Reveal intention?
Semantic Versioning
2.3.4 •Incompatible API changes
2.3.4 •Incompatible API changes •Backward-compatible features
2.3.4 •Incompatible API changes •Backward-compatible features •Backward-compatible bug fixes •http://semver.org
SemVer and RubyGems 'rake', '~> 10.0.3' 10.0.3 to 10.0.99…
SemVer and RubyGems 'rake', '~> 10.0', '>= 10.0.3' 10.0.3 to
10.99…
Reduce Barriers
“This is what your tool chain looks like to people
not ‘in the know’. They just want to do a thing” @jessenoller
How Do I Start? •CONTRIBUTING.txt •run: bundle •How do I
run the tests? •hoe: rake newb
CONTRIBUTING.txt •Your process •fork, edit, test, pull request •Code conventions
•Vocabulary
Automate Everything •Travis-CI •Generate files •Run tests •Release
How to Contribute
What Gems do You Use?
Gems You Use •Report bugs •Report bad documentation •Hard to
understand •Missing examples
Pull Requests •Contact the maintainers: “How would I fix issue
#XXX” •Start small •Try different projects
Scratch Your Own Itch
Code Climate •Free for github projects •Uses flog and flay
•Refactoring targets •Method duplication •Complexity
Thank You