Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Sign up for free
Menu
Search
Features
All features
Private URLs
Password Protection
Custom URLS
Scheduled publishing
Remove Branding
Restrict embedding
Deck Collections
Notes
Features
All features
Private URLs
Password Protection
Custom URLS
Scheduled publishing
Remove Branding
Restrict embedding
Deck Collections
Notes
Explore
Featured decks
Featured speakers
Programming
Technology
Storyboards
Explore
Featured decks
Featured speakers
Programming
Technology
Storyboards
Pricing
Search
Sign in
Sign up for free
Open Source Maintenance — RailsClub Moscow
Search
Sponsored
·
SiteGround - Reliable hosting with speed, security, and support you can count on.
→
Eric Hodel
September 28, 2013
Programming
190
1
Share
Embed
Copy iframe code
Copy JS code
Copy link
Start on current slide
Open Source Maintenance — RailsClub Moscow
Presented at RailsClub Moscow 2013
Eric Hodel
September 28, 2013
Transcript
75 slides
Open Source Maintenance Eric Hodel -
[email protected]
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
More Decks by Eric Hodel
See All by Eric Hodel
Building maintainable command-line tools with MRuby
drbrain
0
730
Introduction to Rake
drbrain
0
420
Lazy Enumeration
drbrain
0
160
Lessons in Mentorship
drbrain
1
280
Open Source Maintenance — Ruby on Ales 2014
drbrain
1
160
drbdump
drbrain
2
580
Other Decks in Programming
See All in Programming
React Native에 현대적인 빌드 도구 더하기: Rollipop 구현기
leegeunhyeok
0
190
AIがコードを書いてくれる時代、我々は何を確かめるのか
yosuke_furukawa
PRO
13
6.1k
エラーチャンネルのボールを拾い続けて鍛えるエンジニアの地力 / phpcon-niigata2026
meihei3
1
460
ローカルLLMの基本と近況 2611 / Local LLM basics and recent situation 2611
kishida
3
600
baseline으로 마이그레이션, 리팩토링 안전하게 맡기기
fornewid
1
1k
AI Augmentation Techniques with Liberty
ivargrimstad
1
520
Rails初心者がパスキーを実装してみて大変だったこと
ktombow
0
220
まずはコードより業務と向き合う:テーブル解体のためにPdMを呼んだ話
sakawe_ee
0
250
Claude Codeのおかげでやりたいことがやれるようになったんだよォー!
sms_tech
0
160
あなたの await、OS まで届いてる? strace で覗く JavaScript の非同期
hasutosasaki
1
2.4k
自宅サーバはどこまで再現できるのか - Proxmox VE上のVM環境をIaCとバックアップで戻してみた
youto
0
430
flutter_test のその先へ — Flutter アプリの LLM 機能に「評価」という品質保証を
kosukesaigusa
0
210
Featured
See All Featured
How to audit for AI Accessibility on your Front & Back End
davetheseo
0
640
Measuring & Analyzing Core Web Vitals
bluesmoon
9
1.1k
Code Review Best Practice
trishagee
74
20k
Why Our Code Smells
bkeepers
PRO
340
58k
Building a Modern Day E-commerce SEO Strategy
aleyda
45
9.3k
Money Talks: Using Revenue to Get Sh*t Done
nikkihalliwell
0
570
Rails Girls Zürich Keynote
gr2m
96
14k
Bridging the Design Gap: How Collaborative Modelling removes blockers to flow between stakeholders and teams @FastFlow conf
baasie
0
770
Refactoring Trust on Your Teams (GOTO; Chicago 2020)
rmw
35
3.9k
What’s in a name? Adding method to the madness
productmarketing
PRO
24
4.2k
Rebuilding a faster, lazier Slack
samanthasiow
85
9.8k
Stop Working from a Prison Cell
hatefulcrawdad
274
21k