Meaningful Code (WomenWhoCode - September 2018)

In today's crazy world of software development, we sometime tend to forget that coding is a craft and the code must stay meaningful in order for it to be good.

Here is my view on how we can try to make meaningful code, and hopefully that will help some people along the way.

Transcript

1. Meaningful Code September 2018 Yannick Lemin
2. Hello :) My name is Yannick
3. Who am I?
4. Craft
5. Software Craftsmanship
9. What makes code Meaningful?
10. What makes code Meaningful? • Understandable (even after 6 month) • Shareable • Robust • Clean • Reusable • …
11. Have a drink!
12. Yann’s Tips to help write code that you can be proud of (hopefully)
13. 1. Working with a team
14. 1. Working with a team THE TEAM IS ALWAYS RIGHT
15. 2. Naming
16. 2. Naming NAMING IS HARD!
17. 2. Naming • Spend enough time • In doubt: ask the team • You can always refactor later
18. 3. Write code for Others
19. 3. Write code for Others •Others could be YOU … from the FUTURE!
20. Hello hydration!
21. 4. Write readable code
22. 4. Write readable code • Write concise, short and clear functions • Name them right (remember … Naming is?) • Will serve as documentation
25. 5. Careful with comments in code
26. 5. Careful with comments in code • Avoid comments as much as possible • UNLESS YOU ARE WRITING A PUBLIC API
31. 6. Pay attention to Warnings
32. 6. Pay attention to Warnings • They are there for a REASON • Get rid of them as much as possible • If you keep some, make sure you understand the potential consequences • Use Lint tools
35. Last drinking break!
36. 7 . Testing
37. 7 . Testing • Unit Testing • Integration Testing • End-To-End Testing
38. – Me “Automated testing is the most powerful tool in your arsenal.”
39. 7 . Testing :( • Testing takes time • Tests must be maintained • Tests can be complicated
40. 7 . Testing :) • Tests are a very useful documentation • Tests are a safety net during refactoring • They help with the development of unit features (regex, string formatting, calculations, etc) • When the tests are launched, nothing will be forgotten
41. 8. Refactoring
42. 8. Refactoring • Refactoring is part of the development process • You won’t write the perfect code the first time • Only write the code that is needed
43. – Uncle Bob Martin “Refactoring should never be a task on the board, it is never something that is added to an agenda. It is always part of the development process”
44. 9. Language
45. 9. Language Just use one!
46. 10. Code Review
47. 10. Code Review • Share the knowledge • Learn things • Give your opinion • Question the decisions • Share the love
48. 11. Conferences / Meetups / Hackathons …
49. Summary • Work in a team (THE TEAM IS ALWAYS RIGHT!) • Naming is Hard! • Write code for others • Make that code readable • Avoid comments • Pay attention to warnings • Automated testing is AWESOME • Refactoring is part of the process • Use one language • Code Review is cool • Go to events
52. And this one is important!
53. It may seem obvious …
54. but still I think it’s important to mention it!
55. DO NOT FORGET TO LIVE!
56. Thank you :)