Slide 1
Slide 1 text
http://commons.wikimedia.org/wiki/File:Cress_keyboard-3_sprouting_other_side.jpg
Garden
@BKEEPERS
TENDING YOUR OPEN SOURCE
!
Slide 2
Slide 2 text
http://en.wikipedia.org/wiki/Garden_gnome_liberationists
"bkeepers
Slide 3
Slide 3 text
I ♥ ⚘
Slide 4
Slide 4 text
I like writing software because I like gardening.
https://www.flickr.com/photos/91663396@N00/7080354723/
Slide 5
Slide 5 text
Open Source is like community gardening.
https://www.flickr.com/photos/antoinettevanderieth/8753016923
Slide 6
Slide 6 text
P L A N
C U L T I V A T E
S O W
W A T E R
M U L C H
P R U N E
H A R V E S T
Slide 7
Slide 7 text
M Y G A R D E N S
Slide 8
Slide 8 text
M Y G A R D E N S
dotenv
Slide 9
Slide 9 text
M Y G A R D E N S
dotenv
delayed_job
Slide 10
Slide 10 text
M Y G A R D E N S
dotenv
delayed_job
qu
Slide 11
Slide 11 text
M Y G A R D E N S
dotenv
delayed_job
qu
tinder
Slide 12
Slide 12 text
M Y G A R D E N S
dotenv
delayed_job
qu
tinder
rosie
Slide 13
Slide 13 text
M Y G A R D E N S
dotenv
delayed_job
qu
tinder
rosie
github-notifications
Slide 14
Slide 14 text
Large open source projects are like farming…
https://www.flickr.com/photos/messycupcakes/7722551044/
Slide 15
Slide 15 text
…or land management.
https://www.flickr.com/photos/47096398@N08/7462466876
Slide 16
Slide 16 text
Steve Klabnik
http://words.steveklabnik.com/how-to-be-an-open-source-gardener
Slide 17
Slide 17 text
I’m talking about gardening
Slide 18
Slide 18 text
Plan
https://www.flickr.com/photos/btobin/4456582998
Slide 19
Slide 19 text
What are your motivations?
Slide 20
Slide 20 text
The ultimate goal is to
produce a harvest.
Slide 21
Slide 21 text
How much time can you dedicate?
https://www.flickr.com/photos/ugardener/3553160869
Slide 22
Slide 22 text
Open source is hard work, but it
often leads to better software.
https://www.flickr.com/photos/ugardener/3553160869
Slide 23
Slide 23 text
Cultivate
https://www.flickr.com/photos/librariesrock/3760104913
Slide 24
Slide 24 text
Pick a good name.
Slide 25
Slide 25 text
What makes a name “good”?
1. Searchable
2. Memorable
3. Suggestive
4. Not too boring
5. Not too weird
6. Not too trendy
Slide 26
Slide 26 text
No content
Slide 27
Slide 27 text
Q U
Slide 28
Slide 28 text
Q U
OMG, a Better Background Queue!
Slide 29
Slide 29 text
O M G B B Q
OMG, a Better Background Queue!
Slide 30
Slide 30 text
Write documentation.
Slide 31
Slide 31 text
one-line description
longer explanation
What makes a
good README?
Slide 32
Slide 32 text
one-line description
longer explanation
how to install it
Slide 33
Slide 33 text
one-line description
longer explanation
how to install it
how to use it
Slide 34
Slide 34 text
how to contribute
Slide 35
Slide 35 text
See github.com/trending for examples
Slide 36
Slide 36 text
Choose a license.
https://www.flickr.com/photos/andrewprickett/6649056779/
Slide 37
Slide 37 text
ChooseALicense.com
Slide 38
Slide 38 text
Follow conventions.
https://www.flickr.com/photos/cccpxokkeu/8580600558/
Slide 39
Slide 39 text
Sow
https://www.flickr.com/photos/nateswartphoto/5623220460
Slide 40
Slide 40 text
This is the easiest part.
Slide 41
Slide 41 text
Tell the world about it.
Slide 42
Slide 42 text
Blog about it.
Slide 43
Slide 43 text
!
Slide 44
Slide 44 text
Now, ready to work?
Slide 45
Slide 45 text
Water
http://en.wikipedia.org/?title=Talk:Rainbow/Archive_1#mediaviewer/File:Self_Made_Rainbow.JPG
Slide 46
Slide 46 text
Consistency and
diligence are crucial.
Slide 47
Slide 47 text
Follow your own contribution guidelines.
Slide 48
Slide 48 text
Invite people in.
Slide 49
Slide 49 text
Always be hospitable.
Slide 50
Slide 50 text
Give it time.
https://www.flickr.com/photos/onegiantleap/4124211492
Slide 51
Slide 51 text
Mulch
https://www.flickr.com/photos/chiotsrun/3247946933
Slide 52
Slide 52 text
Only add features that
you want to maintain.
https://www.flickr.com/photos/ajbatac/7179488176
Slide 53
Slide 53 text
Tests guard against erosion.
Slide 54
Slide 54 text
Continuous integration gives contributors confidence.
Slide 55
Slide 55 text
D O N ’ T F E E D
T H E T R O L L S
https://www.flickr.com/photos/eldave/3332622539
Slide 56
Slide 56 text
Prune
https://www.flickr.com/photos/jeremyhiebert/5454990146
Slide 57
Slide 57 text
Remove features that you
don’t want to maintain.
Slide 58
Slide 58 text
Split them into separate
repositories.
Slide 59
Slide 59 text
dotenv-deployment
Slide 60
Slide 60 text
Use semantic versioning
https://www.flickr.com/photos/jimfischer/8384524415
1.2.6
minor patch
major
semver.org
Slide 61
Slide 61 text
Use semantic versioning
https://www.flickr.com/photos/jimfischer/8384524415
1.2.6
minor patch
major
}
backwards-compatibile bug fixes
semver.org
Slide 62
Slide 62 text
Use semantic versioning
https://www.flickr.com/photos/jimfischer/8384524415
1.2.6
minor patch
major
}
backwards-compatible functionality
semver.org
Slide 63
Slide 63 text
Use semantic versioning
https://www.flickr.com/photos/jimfischer/8384524415
1.2.6
minor patch
major
}
incompatible API changes
semver.org
Slide 64
Slide 64 text
Deprecate features in
minor versions, remove
them in major versions
https://www.flickr.com/photos/jimfischer/8384524415
Slide 65
Slide 65 text
1.x.x
https://www.flickr.com/photos/jimfischer/8384524415
if using_deprecated_feature?
warn "[DEPRECATION] This feature has been " +
"deprecated and will be removed in 2.0.",
caller[0]
# deprecated functionality here
end
Slide 66
Slide 66 text
Keep a changelog.
http://bit.ly/1mfVB3d
Slide 67
Slide 67 text
Changelog.md
http://bit.ly/1mfVB3d
Slide 68
Slide 68 text
Harvest
Slide 69
Slide 69 text
Give it away when it
stops being fun.
Slide 70
Slide 70 text
…unless you still
depend on it.
Slide 71
Slide 71 text
Clearly state the project’s status.
Slide 72
Slide 72 text
G R I T
Slide 73
Slide 73 text
No content
Slide 74
Slide 74 text
No content
Slide 75
Slide 75 text
No content
Slide 76
Slide 76 text
Learn from your mistakes.
Slide 77
Slide 77 text
“For the record, I am a terrible
open source maintainer.
— @bkeepers - 7 Jan 2014
Slide 78
Slide 78 text
Thank You
" bkeepers