Open Source Stewardship

Slide 1

Slide 1 text

Open Source Stewardship A talk about how to build the best version of your software

Slide 2

Slide 2 text

Stewardship is an old word

Slide 3

Slide 3 text

Stewardship (n.) An ethic that embodies the responsible planning and management of resources. Old English: stiward, stigweard "house guardian, housekeeper," from stig "hall, pen for cattle, part of a house"

Slide 4

Slide 4 text

No content

Slide 5

Slide 5 text

What's the use of an old word in this brave new world?

Slide 6

Slide 6 text

ISO 20121 Event Sustainability Management System Requirements with guidance for use; ❡3.20: "Responsibility for sustainable development shared by all those whose actions affect environmental performance, economic activity, and social progress, reﬂected as both a value and a practice by individuals, organisations, communities, and competent authorities."

Slide 7

Slide 7 text

Gift Economy

Slide 8

Slide 8 text

No content

Slide 9

Slide 9 text

Commodity vs. Gift Exchange "Gifts and Commodities" (1982), by Chris Gregory — immediate vs. delayed exchange — alienable vs. inaliable goods — indepedent vs. dependent actors — quantitative vs. qualitative relationships — between objects vs. people

Slide 10

Slide 10 text

No content

Slide 11

Slide 11 text

Gift Economies create a virtuous cycle

Slide 12

Slide 12 text

$ whoami - AFNetworking - Nomad CLI - Postgres.app - Induction.app - Helios - Ono - TTTAttributedLabel - FormatterKit - TransformerKit - InflectorKit - CargoBay - GroundControl - SkyLab - Orbiter - ...

Slide 13

Slide 13 text

That Doesn't Matter

Slide 14

Slide 14 text

This talk is as much aspirational as it is (hopefully) instructive. I could be so, so much better at this. I want to be so much better at this. I hope we can get there together.

Slide 15

Slide 15 text

How to Be a Steward of Open Source

Slide 16

Slide 16 text

Every Project Has a Lifecycle - Creating - Maintaining - Transitioning

Slide 17

Slide 17 text

Creating

Slide 18

Slide 18 text

Minimum Viable Project - README - Screenshot - Example Project - License - Means of Distribution

Slide 19

Slide 19 text

README

Slide 20

Slide 20 text

What's in a README? — A short introduction — A section describing the basic usage — A list of requirements and instructions on how to install the project — Links to documentation and resources for additional information — Contact information for the creator — A quick statement about licensing

Slide 21

Slide 21 text

Screenshot

Slide 22

Slide 22 text

A screenshot is worth 1000 seconds

Slide 23

Slide 23 text

No content

Slide 24

Slide 24 text

Example Project

Slide 25

Slide 25 text

(Insert Example)

Slide 26

Slide 26 text

s t r e t c h Your Code - Static Analyzer - Automated Unit Tests - Complete Examples - Use in Production Applications

Slide 27

Slide 27 text

License

Slide 28

Slide 28 text

Good fences make good neighbors

Slide 29

Slide 29 text

Popular Objective-C Open Source Licenses — MIT — Apache 2.0 — BSD — zlib

Slide 30

Slide 30 text

tl;dr MIT License Can — Commercial Use — Private Use — Modify — Distribute — Sublicense

Slide 31

Slide 31 text

tl;dr MIT License Cannot — Hold Liable

Slide 32

Slide 32 text

tl;dr MIT License Must — Include Copyright — Include License

Slide 33

Slide 33 text

Distribution

Slide 34

Slide 34 text

No content

Slide 35

Slide 35 text

NSHipsterKit.podspec Pod::Spec.new do |s| s.name = 'NSHipsterKit' s.version = '1.0.0' s.license = 'MIT' s.summary = "A pretty obscure library. You've probably never heard of it." s.homepage = 'http://nshipster.com' s.authors = { 'Mattt Thompson' => '[email protected]' } s.source = { :git => 'https://github.com/nshipster/NSHipsterKit.git', :tag => '1.0.0' } s.source_files = 'NSHipsterKit' end

Slide 36

Slide 36 text

$ pod push

Slide 37

Slide 37 text

4779 Libraries Currently available through CocoaPods

Slide 38

Slide 38 text

$ pod install

Slide 39

Slide 39 text

Maintaining

Slide 40

Slide 40 text

Maintaining - Responding to Issues - Answering Questions - Versioning

Slide 41

Slide 41 text

Responding to Issues

Slide 42

Slide 42 text

No content

Slide 43

Slide 43 text

You know you've made it when you're writing more on GitHub than in Xcode

Slide 44

Slide 44 text

Slide 45

Slide 45 text

Answering Questions

Slide 46

Slide 46 text

Each question is a data point for what's confusing about your software

Slide 47

Slide 47 text

No content

Slide 48

Slide 48 text

No content

Slide 49

Slide 49 text

No content

Slide 50

Slide 50 text

No content

Slide 51

Slide 51 text

...

Slide 52

Slide 52 text

Versioning

Slide 53

Slide 53 text

Semantic Versioning major . minor . patch

Slide 54

Slide 54 text

Semantic Versioning Guidelines http://semver.org — MAJOR version when you make incompatible API changes, — MINOR version when you add functionality in a backwards-compatible manner, and — PATCH version when you make backwards-compatible bug ﬁxes.

Slide 55

Slide 55 text

How often to bump?

Slide 56

Slide 56 text

Transitioning

Slide 57

Slide 57 text

Transitioning - Delegating - Recruiting - Sunsetting

Slide 58

Slide 58 text

Delegating

Slide 59

Slide 59 text

Delegating is one of the hardest things to do. Period.

Slide 60

Slide 60 text

@protocol OSSDelegate @property (getter = isEmpathetic) BOOL empathetic; - (void)communicateWithClass:(Class)always; - (void)take:(id)charge and:(id)responsibility; - (void)knowWhatThe:(id)bleep theyAreDoingWith:(id)domain; @optional - (BOOL)conformsToYourExactWayOfDoingThings; @end

Slide 61

Slide 61 text

Recruiting

Slide 62

Slide 62 text

Contributor today, maintainer tomorrow

Slide 63

Slide 63 text

No content

Slide 64

Slide 64 text

Sunsetting

Slide 65

Slide 65 text

No content

Slide 66

Slide 66 text

Without a graceful exit, a project is doomed to do more harm than good.

Slide 67

Slide 67 text

Wrapping Up — Announce the end of the project, offering suggestions for how to migrate to another solution. — Keep the project around, but make a commit that removes source ﬁles from the master branch. (git will keep everything safe in history) — Thank everyone involved for their help and contributions.

Slide 68

Slide 68 text

Wrapping Up

Slide 69

Slide 69 text

We are in the midst of a Renaissance with Objective-C ...and it has as much to do with the language as it does with the community