$30 off During Our Annual Pro Sale. View Details »

Tending Your Open Source Garden

Tending Your Open Source Garden

Brandon Keepers
PRO

June 26, 2014
Tweet

More Decks by Brandon Keepers

Other Decks in Technology

Transcript

  1. http://commons.wikimedia.org/wiki/File:Cress_keyboard-3_sprouting_other_side.jpg
    Garden
    @BKEEPERS
    TENDING YOUR OPEN SOURCE
    !

    View Slide

  2. http://en.wikipedia.org/wiki/Garden_gnome_liberationists
    "bkeepers

    View Slide

  3. I ♥ ⚘

    View Slide

  4. I like writing software because I like gardening.
    https://www.flickr.com/photos/91663396@N00/7080354723/

    View Slide

  5. Open Source is like community gardening.
    https://www.flickr.com/photos/antoinettevanderieth/8753016923

    View Slide

  6. 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

    View Slide

  7. M Y G A R D E N S

    View Slide

  8. M Y G A R D E N S
    dotenv

    View Slide

  9. M Y G A R D E N S
    dotenv
    delayed_job

    View Slide

  10. M Y G A R D E N S
    dotenv
    delayed_job
    qu

    View Slide

  11. M Y G A R D E N S
    dotenv
    delayed_job
    qu
    tinder

    View Slide

  12. M Y G A R D E N S
    dotenv
    delayed_job
    qu
    tinder
    rosie

    View Slide

  13. M Y G A R D E N S
    dotenv
    delayed_job
    qu
    tinder
    rosie
    github-notifications

    View Slide

  14. Large open source projects are like farming…
    https://www.flickr.com/photos/messycupcakes/7722551044/

    View Slide

  15. …or land management.
    https://www.flickr.com/photos/47096398@N08/7462466876

    View Slide

  16. Steve Klabnik
    http://words.steveklabnik.com/how-to-be-an-open-source-gardener

    View Slide

  17. I’m talking about gardening

    View Slide

  18. Plan
    https://www.flickr.com/photos/btobin/4456582998

    View Slide

  19. What are your motivations?

    View Slide

  20. The ultimate goal is to
    produce a harvest.

    View Slide

  21. How much time can you dedicate?
    https://www.flickr.com/photos/ugardener/3553160869

    View Slide

  22. Open source is hard work, but it
    often leads to better software.
    https://www.flickr.com/photos/ugardener/3553160869

    View Slide

  23. Cultivate
    https://www.flickr.com/photos/librariesrock/3760104913

    View Slide

  24. Pick a good name.

    View Slide

  25. What makes a name “good”?
    1. Searchable
    2. Memorable
    3. Suggestive

    4. Not too boring
    5. Not too weird
    6. Not too trendy

    View Slide

  26. View Slide

  27. Q U

    View Slide

  28. Q U
    OMG, a Better Background Queue!

    View Slide

  29. O M G B B Q
    OMG, a Better Background Queue!

    View Slide

  30. Write documentation.

    View Slide

  31. one-line description
    longer explanation
    What makes a
    good README?

    View Slide

  32. one-line description
    longer explanation
    how to install it

    View Slide

  33. one-line description
    longer explanation
    how to install it
    how to use it

    View Slide

  34. how to contribute

    View Slide

  35. See github.com/trending for examples

    View Slide

  36. Choose a license.
    https://www.flickr.com/photos/andrewprickett/6649056779/

    View Slide

  37. ChooseALicense.com

    View Slide

  38. Follow conventions.
    https://www.flickr.com/photos/cccpxokkeu/8580600558/

    View Slide

  39. Sow
    https://www.flickr.com/photos/nateswartphoto/5623220460

    View Slide

  40. This is the easiest part.

    View Slide

  41. Tell the world about it.

    View Slide

  42. Blog about it.

    View Slide

  43. !

    View Slide

  44. Now, ready to work?

    View Slide

  45. Water
    http://en.wikipedia.org/?title=Talk:Rainbow/Archive_1#mediaviewer/File:Self_Made_Rainbow.JPG

    View Slide

  46. Consistency and
    diligence are crucial.

    View Slide

  47. Follow your own contribution guidelines.

    View Slide

  48. Invite people in.

    View Slide

  49. Always be hospitable.

    View Slide

  50. Give it time.
    https://www.flickr.com/photos/onegiantleap/4124211492

    View Slide

  51. Mulch
    https://www.flickr.com/photos/chiotsrun/3247946933

    View Slide

  52. Only add features that
    you want to maintain.
    https://www.flickr.com/photos/ajbatac/7179488176

    View Slide

  53. Tests guard against erosion.

    View Slide

  54. Continuous integration gives contributors confidence.

    View Slide

  55. D O N ’ T F E E D
    T H E T R O L L S
    https://www.flickr.com/photos/eldave/3332622539

    View Slide

  56. Prune
    https://www.flickr.com/photos/jeremyhiebert/5454990146

    View Slide

  57. Remove features that you
    don’t want to maintain.

    View Slide

  58. Split them into separate
    repositories.

    View Slide

  59. dotenv-deployment

    View Slide

  60. Use semantic versioning
    https://www.flickr.com/photos/jimfischer/8384524415
    1.2.6
    minor patch
    major
    semver.org

    View Slide

  61. Use semantic versioning
    https://www.flickr.com/photos/jimfischer/8384524415
    1.2.6
    minor patch
    major
    }
    backwards-compatibile bug fixes
    semver.org

    View Slide

  62. Use semantic versioning
    https://www.flickr.com/photos/jimfischer/8384524415
    1.2.6
    minor patch
    major
    }
    backwards-compatible functionality
    semver.org

    View Slide

  63. Use semantic versioning
    https://www.flickr.com/photos/jimfischer/8384524415
    1.2.6
    minor patch
    major
    }
    incompatible API changes
    semver.org

    View Slide

  64. Deprecate features in
    minor versions, remove
    them in major versions
    https://www.flickr.com/photos/jimfischer/8384524415

    View Slide

  65. 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

    View Slide

  66. Keep a changelog.
    http://bit.ly/1mfVB3d

    View Slide

  67. Changelog.md
    http://bit.ly/1mfVB3d

    View Slide

  68. Harvest

    View Slide

  69. Give it away when it
    stops being fun.

    View Slide

  70. …unless you still
    depend on it.

    View Slide

  71. Clearly state the project’s status.

    View Slide

  72. G R I T

    View Slide

  73. View Slide

  74. View Slide

  75. View Slide

  76. Learn from your mistakes.

    View Slide

  77. “For the record, I am a terrible
    open source maintainer.
    — @bkeepers - 7 Jan 2014

    View Slide

  78. Thank You
    " bkeepers

    View Slide