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
150
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
98
drbdump
drbrain
2
470
Other Decks in Programming
See All in Programming
AI Agentを利用したAndroid開発について
yuchan2215
0
190
家族・子育て重視/沖縄在住を維持しながらエンジニアとしてのキャリアをどのように育てていくか?
ug
0
210
Devin , 正しい付き合い方と使い方 / Living and Working with Devin
yukinagae
1
490
WordPress Playground for Developers
iambherulal
0
110
S3静的ホスティング+Next.js静的エクスポート で格安webアプリ構築
iharuoru
0
160
新卒から4年間、20年もののWebサービスと 向き合って学んだソフトウェア考古学
oguri
7
6.3k
私の愛したLaravel 〜レールを超えたその先へ〜
kentaroutakeda
11
2.9k
なぜselectはselectではないのか
taiyow
2
260
Effective Signals in Angular 19+ Rules and Helpers
manfredsteyer
PRO
0
180
CIBMTR振り返り+敗北から学ぶコンペの取り組み方反省
takanao
1
500
複数ドメインに散らばってしまった画像…! 運用中のPHPアプリに後からCDNを導入する…!
suguruooki
0
370
生産性アップのためのAI個人活用
kunoyasu
0
460
Featured
See All Featured
The Language of Interfaces
destraynor
156
24k
GitHub's CSS Performance
jonrohan
1030
460k
実際に使うSQLの書き方 徹底解説 / pgcon21j-tutorial
soudai
176
52k
The Art of Programming - Codeland 2020
erikaheidi
53
13k
Speed Design
sergeychernyshev
28
850
Measuring & Analyzing Core Web Vitals
bluesmoon
6
320
Testing 201, or: Great Expectations
jmmastey
42
7.3k
Stop Working from a Prison Cell
hatefulcrawdad
268
20k
Evolution of real-time – Irina Nazarova, EuRuKo, 2024
irinanazarova
6
600
ピンチをチャンスに:未来をつくるプロダクトロードマップ #pmconf2020
aki_iinuma
117
51k
Automating Front-end Workflow
addyosmani
1369
200k
The Web Performance Landscape in 2024 [PerfNow 2024]
tammyeverts
4
480
Transcript
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