Slide 1

Slide 1 text

MAINTAINING A BIG OPEN SOURCE PROJECT: LESSONS LEARNED Leonardo Tegon - RailsConf 2019

Slide 2

Slide 2 text

No content

Slide 3

Slide 3 text

No content

Slide 4

Slide 4 text

No content

Slide 5

Slide 5 text

No content

Slide 6

Slide 6 text

twitter.com/tegonl github.com/tegon

Slide 7

Slide 7 text

No content

Slide 8

Slide 8 text

WE GET PAYED BY CLIENTS TO DELIVER PROJECTS

Slide 9

Slide 9 text

SPARE TIME

Slide 10

Slide 10 text

THE PROJECTS BECAME INACTIVE

Slide 11

Slide 11 text

I WANTED TO HELP

Slide 12

Slide 12 text

I DIDN'T KNOW WHERE TO START

Slide 13

Slide 13 text

RUBYCONF BRASIL 2017

Slide 14

Slide 14 text

The future of the Ruby community is brilliant but it depends on us — Rafael França

Slide 15

Slide 15 text

No content

Slide 16

Slide 16 text

NOVEMBER 2017

Slide 17

Slide 17 text

APRIL 2019

Slide 18

Slide 18 text

No content

Slide 19

Slide 19 text

YOU'RE GOOD ENOUGH

Slide 20

Slide 20 text

WHERE DO I START?

Slide 21

Slide 21 text

ISSUE TRIAGE

Slide 22

Slide 22 text

TRIAGE The process of examining problems in order to decide which ones are the most serious and must be dealt with first

Slide 23

Slide 23 text

ISSUE TRIAGE Ensure that existing issues follow the recommendations from the project's contribution guide

Slide 24

Slide 24 text

CONTRIBUTING.MD

Slide 25

Slide 25 text

Include a title and a clear description, as much relevant information as possible and either a test case or a sample Rails app that replicates the issue — Devise's contribution guide

Slide 26

Slide 26 text

IT'S HARD TO FIX BUGS WITHOUT ENOUGH INFORMATION

Slide 27

Slide 27 text

TRY TO REPRODUCE THE ISSUE IN ISOLATION

Slide 28

Slide 28 text

No content

Slide 29

Slide 29 text

No content

Slide 30

Slide 30 text

Avoid opening new issues to ask questions[...]. Please go through the project wiki, documentation and source code first, or try to ask your question on Stack Overflow. — Devise's contribution guide

Slide 31

Slide 31 text

IT'S IMPORTANT TO ASK QUESTIONS

Slide 32

Slide 32 text

THE ISSUES TRACKER MAY NOT BE THE BEST PLACE

Slide 33

Slide 33 text

No content

Slide 34

Slide 34 text

IT'S HARD TO ASK QUESTIONS

Slide 35

Slide 35 text

No content

Slide 36

Slide 36 text

ISSUE TRIAGE IS A GREAT WAY TO START

Slide 37

Slide 37 text

https://words.steveklabnik.com/how-to-be-an-open-source-gardener

Slide 38

Slide 38 text

15 MINUTES PER DAY

Slide 39

Slide 39 text

BUT I'M NOT A MAINTAINER!

Slide 40

Slide 40 text

No content

Slide 41

Slide 41 text

No content

Slide 42

Slide 42 text

THERE ARE OTHER WAYS TO START

Slide 43

Slide 43 text

REVIEW PULL REQUESTS

Slide 44

Slide 44 text

ASK FOR TESTS

Slide 45

Slide 45 text

TEST THE SOLUTION

Slide 46

Slide 46 text

REPRODUCE AN ISSUE

Slide 47

Slide 47 text

SHARE YOUR SOLUTION

Slide 48

Slide 48 text

No content

Slide 49

Slide 49 text

DOCUMENTATION

Slide 50

Slide 50 text

No content

Slide 51

Slide 51 text

#1. OPEN SOURCE IS MORE THAN CODE

Slide 52

Slide 52 text

No content

Slide 53

Slide 53 text

REPRODUCE THE ISSUE

Slide 54

Slide 54 text

REGRESSION

Slide 55

Slide 55 text

https://thoughtbot.com/blog/git-bisect

Slide 56

Slide 56 text

UNKNOWN ISSUES

Slide 57

Slide 57 text

DIVE INTO THE CODE

Slide 58

Slide 58 text

gem "pry"

Slide 59

Slide 59 text

https://www.jackkinsella.ie/articles/debugging-rails-with-pry-debugger

Slide 60

Slide 60 text

https://docs.gitlab.com/ee/development/pry_debugging.html

Slide 61

Slide 61 text

https://medium.com/@urish/reading-your-frameworks-source-code-yes-you-can-do-it-2bdd8c9e947b

Slide 62

Slide 62 text

YOU FOUND THE CODE THAT'S CAUSING THE ISSUE

Slide 63

Slide 63 text

Once we read a piece of code for the very first time, we’re immersed in a long learning curve and a continuous cycle of questionings, doubts, and insights. — Rondy Sousa

Slide 64

Slide 64 text

"WHAT WERE THEY THINKING?"

Slide 65

Slide 65 text

"THIS MAKES NO SENSE"

Slide 66

Slide 66 text

"THEY COULD HAVE DONE X INSTEAD"

Slide 67

Slide 67 text

No content

Slide 68

Slide 68 text

No content

Slide 69

Slide 69 text

No content

Slide 70

Slide 70 text

No content

Slide 71

Slide 71 text

No content

Slide 72

Slide 72 text

No content

Slide 73

Slide 73 text

WE HAVE A LIMITED VISION OF THE WORLD

Slide 74

Slide 74 text

No content

Slide 75

Slide 75 text

No content

Slide 76

Slide 76 text

ASK FOR ADVICE

Slide 77

Slide 77 text

No content

Slide 78

Slide 78 text

#2. IT'S OK TO MAKE MISTAKES

Slide 79

Slide 79 text

WHAT SHOULD I HAVE DONE?

Slide 80

Slide 80 text

WHAT CAN I DO FROM NOW ON?

Slide 81

Slide 81 text

No content

Slide 82

Slide 82 text

No content

Slide 83

Slide 83 text

#3. DOCUMENT THE DECISIONS

Slide 84

Slide 84 text

No content

Slide 85

Slide 85 text

GIT COMMIT MESSAGES

Slide 86

Slide 86 text

https://thoughtbot.com/blog/5-useful-tips-for-a-better-commit-message

Slide 87

Slide 87 text

https://chris.beams.io/posts/git-commit/

Slide 88

Slide 88 text

No content

Slide 89

Slide 89 text

#4. CODE IS EXPENSIVE

Slide 90

Slide 90 text

No content

Slide 91

Slide 91 text

#5. BE NICE

Slide 92

Slide 92 text

No content

Slide 93

Slide 93 text

No content

Slide 94

Slide 94 text

RESPECT OTHER OPINIONS

Slide 95

Slide 95 text

ASK QUESTIONS

Slide 96

Slide 96 text

HAVE EMPATHY

Slide 97

Slide 97 text

No content

Slide 98

Slide 98 text

No content

Slide 99

Slide 99 text

No content

Slide 100

Slide 100 text

https://signalvnoise.com/posts/3124-give-it-five-minutes

Slide 101

Slide 101 text

GIVE IT A DAY

Slide 102

Slide 102 text

No content

Slide 103

Slide 103 text

No content

Slide 104

Slide 104 text

GIVE IT A DAY

Slide 105

Slide 105 text

No content

Slide 106

Slide 106 text

#6. TAKE CARE OF YOURSELF

Slide 107

Slide 107 text

RELY ON AUTOMATED TOOLS

Slide 108

Slide 108 text

No content

Slide 109

Slide 109 text

No content

Slide 110

Slide 110 text

No content

Slide 111

Slide 111 text

ASK FOR HELP

Slide 112

Slide 112 text

COMMUNITY

Slide 113

Slide 113 text

No content

Slide 114

Slide 114 text

No content

Slide 115

Slide 115 text

SHOW YOUR COMPANY WHY OSS IS IMPORTANT

Slide 116

Slide 116 text

WHY OSS IS IMPORTANT •Blog posts •Talks •Motivation •Professional development

Slide 117

Slide 117 text

OSS FRIDAYS

Slide 118

Slide 118 text

PAID EXTRA HOURS

Slide 119

Slide 119 text

No content

Slide 120

Slide 120 text

YOU DON'T NEED TO CODE TO HELP

Slide 121

Slide 121 text

DOCUMENT THE DECISIONS

Slide 122

Slide 122 text

BE NICE

Slide 123

Slide 123 text

ASK FOR HELP

Slide 124

Slide 124 text

No content

Slide 125

Slide 125 text

JOSÉ VALIM github.com/josevalim

Slide 126

Slide 126 text

RAFAEL FRANÇA github.com/rafaelfranca

Slide 127

Slide 127 text

FELIPE RENAN github.com/feliperenan

Slide 128

Slide 128 text

THANK YOU! twitter.com/tegonl github.com/tegon

Slide 129

Slide 129 text

REFERENCES •http://blog.plataformatec.com.br/2014/05/tips-for-keeping-your-open-source-software-issues- tracker-tidy/ •https://words.steveklabnik.com/how-to-be-an-open-source-gardener •http://blog.plataformatec.com.br/2018/06/the-anatomy-of-code-documentation/ •https://thoughtbot.com/blog/git-bisect •https://www.jackkinsella.ie/articles/debugging-rails-with-pry-debugger •https://thoughtbot.com/blog/5-useful-tips-for-a-better-commit-message •https://chris.beams.io/posts/git-commit/

Slide 130

Slide 130 text

IMAGE CREDITS •Helena Lopes: https://unsplash.com/photos/1m2LQEonm2A •Pawel Janiak: https://unsplash.com/photos/WtRuYJ2EPMA •Alejandro Escamilla: https://unsplash.com/photos/BbQLHCpVUqA •Sharon McCutcheon: https://unsplash.com/photos/8lnbXtxFGZw •Alexis Brown: https://unsplash.com/photos/-Xv7k95vOFA •Angelina Kichukova: https://unsplash.com/photos/AjaOjlImLjM •GIFs: https://giphy.com/brooklynninenine