Keeping Code Style Sanity in a 13-year-old Codebase

Transcript

1. Keeping code style sanity in a 10-year-old codebase 13
2. Gabi Stefanini
3. @lastgabs
4. 1year at Shopify year programming Ruby year coding Rails apps time ever in a tech conference time speaking to a tech crowd
6. What is this talk not about?
7. So…?
8. Back to the beginning
10. Over 13 years
11. We have lots of code 1
14. Lots of developers 2
16. … and growing
17. What does this mean for code style consistency?
18. Unique problems
19. Creative solutions
20. 700k LOC consistent
21. Do we want to make it consistent?
22. Intention of Ruby
23. –Yukuhiro “Matz” Matsumoto “I want to make Ruby users free. I want to give them the freedom to choose. People are different. People choose different criteria.”
24. Ruby has evolved
26. Shopify was never rewritten
27. Old fashioned
28. Inconsistent
29. Diving into history 2004 2017 2016 2015 2014 2012
30. codebase created 2004
34. (you get the point)
35. draft Ruby style guide 2012
37. Rubocop gem added 2014 September
40. Stop the bleeding
41. Policial gem was born 2015 March
42. Policial
45. Github commit status API Shopify Ruby style guide 2015 October
46. Github commit status API 1
50. Opt-in feature
51. Great adoption rate
52. Shopify Ruby style guide 2
55. Policial feedback 2016 March
56. Do you believe Policial has a positive role in our pull requests?
57. Negative 7% Neutral 7% Positive 85% Do you believe Policial has a positive role in our pull requests?
58. “Helps onboard new team members” “Allows code reviews to focus on logic instead of style” “Makes code more readable”
59. “Delays merging my PR” “Sometimes makes files less consistent, reducing readability”
61. Did you learn something valuable with Policial?
62. No 32% Yes 68% Did you learn something valuable with Policial?
63. “Syntax improvements” “Style best practices” “Easier to write Ruby coming from other languages”
64. “Ruby is not new for me, so I know all these” “It doesn’t provide much insight into why the rules exist and how they improve our codebase.”
65. Does Policial make your life easier?
66. No 12% Neutral 10% Yes 78% Does Policial make your life easier?
67. “It’s making the code base more predictable” “Helps me not to worry about what the standard code style should be when I’m writing code.”
68. “It usually means I need to spend more time cleaning up.” “Annoying that different projects have different styles.” “The rules or violations are not always clear.”
69. “Policial all the projects!”
70. Policial for all PRs 2016 April
71. Important note: Policial doesn’t fail builds
72. Rubocop in CI Shopify Rails cops 2016 July
73. Rubocop in CI 1
74. Shopify Rails cops 2
76. Rubocop Party - 1st try 2016 October
77. The perfect plan
78. Run all auto-correctable cops through entire codebase 1
80. Pick a downtime to merge them all 2
81. Inform devs in advance 3
82. next weekend…
83. Merge all PRs 4
84. Linted codebase!
85. Ok, no.
86. Why not?
87. It would break git history 1
88. It would make one person responsible for the code 2
89. A week in Shopify-time 3
91. We were definitely not ready.
93. Whitelisting cops 2016 November
94. Controversial rules
95. All cops by default
96. Following Rails steps
97. Improved discussions
98. Github improved git blame 2017 January
100. Rubocop Party - 2nd try 2017 March
101. This time using a bot
103. Add Rubocop auto- correct to our dev tools
104. And adding cops to CI
106. Of course, an issue
107. Slow rubocop container
108. More linted components 2017 April
110. Where we’re at today and where we need to get to
111. Two rubocop.yml files
112. Auto-correct not yet enabled
113. Linter performance in CI isn’t great
114. Contribute with upstream improvements
115. Continue improving our style guide
116. Some final take-aways
117. Have a place for discussion
118. Pick styles that work for your codebase
120. Allow for rules to be challenged
121. It’s all about timing
122. Don’t give up in harder times
123. Have fun!
124. Volmer Soares and Rafael França for sharing the whole story from the beginning and reviewing the content many times over. Florian Weingarten for the instructive conversations, guidance and reviews. Special People:
125. My colleagues who reviewed content, watched the test runs and cheered me on: Adrian Cho, Anita Clarke, Andre Rocha, Quyen Le, Jessica Joly, Andrea Ross, Jace Meyer, Sean Wilson, Sean Griffin and Jaime Woo. Special People: