Code Style as a Cross Squad Practice

Why the adoption of a cross squad/team Code Style Guide is important.
What is the difference between formatting, code conventions and linting.
Why it should not matter what specific standard or Style Guide your team is adopting.

Transcript

1. As a Cross Squad Practice 29/01/2019 Senior Software Engineer Stylist Moritz Kornher Code Style
2. 29/01/2019 A Guide What’s Code Style 2
3. 29/01/2019 What is Code Style 3 Conventions How do we write code? Formatting How does our code look?
4. 29/01/2019 z z z z z z Formatting vs. Conventions. Vs Linting The transformation from one representation of code to another without changing syntax or semantic meaning. It’s the rendering of your code. Formatting 4 What is Code Style Formatting does. A set of guidelines that recommend programming style, practices, and methods for each aspect of a program written in a certain language. Conventions are Review Guidelines. Conventions Conventions encourage. The process of running a program that will analyse code for potential errors. It’s a form of Static Code Analysis. Linting Linting enforces.
5. 29/01/2019 Of common Code Style Benefits 5
6. 29/01/2019 DIY Team-Improvement 6 • Less work thanks to Auto-Fixing • Catch code issues earlier • No more arguing about the colour of the bikeshed • Improves Readability • Improves Interoperability Benefits of common Code Style
7. 29/01/2019 ? ! Game of Quotes 7 Benefits of common Code Style Positive “They're useful for homogenising style across the department, and […] can help reduce more obvious code smells.” Negative “They are draconic and prevent me from writing any code - good or bad.” Action “We should have one, I’m not fussed what’s in it, but it should be universal and enforced!” Uncertainty “Meh, I can see their use, but would be wary of creating one that people adopt, taking a very long time gathering consensus.”
8. 29/01/2019 Of Code Style Guides A Selection 8
9. 29/01/2019 9 The Teacher • ESLint • AirBnB • Google JS
 Style Guide The Helper • Prettier.io • StandardJS A Selection of Code Style Guides
10. 29/01/2019 Why it matters, that it doesn’t matter. A Selection of Code Style Guides 10
11. 29/01/2019 Code Style How to 11
12. 29/01/2019 There be Dragons How to Code Style 12 Last Updated 2016
13. 29/01/2019 13 Integrations How to Code Style Local Pull Request Build Format on Save PR Feedback Fail at build time Part of local test suite Add fix as patch or commit Git commit hooks
14. 29/01/2019 Integration Examples 14 How to Code Style
15. 29/01/2019 Integration Examples 15 How to Code Style
16. 29/01/2019 Integration Examples 16 How to Code Style
17. 29/01/2019 Integration Examples 17 How to Code Style
18. 29/01/2019 Implementation 18 How to Code Style 1. Adopt a Common Code Style • Do a Survey to identify goals and use cases • Suggest a way forward & discuss it • [Decide on the outcome] 2. Collate, create and provide tooling for integrations • Needs to cover identified goals and use cases 3. Enforce within code base • E.g. add PR feedback or start failing builds
19. 29/01/2019 “Thank you”