How not to become a public enemy

Talk about how to design good public APIs and work in collaborative projects

Transcript

1. How not to become a public enemy Sergio Gutiérrez Mota Senior mobile engineer at Karumi
2. We embark on every project with a commitment to create something elegant, enduring and effective. That is our heartbeat. Our approach is uniquely simple and honest, we are a small dedicated software studio, delivering outstanding work. Karumi is the Rock Solid Code software development studio.
3. Pedro Vicente Gómez Alberto Gragera Jorge Barroso Davide Mendolia Senior Mobile Developer Technical Director Senior Android Developer Senior Full Stack Engineer
4. No one ever said it would be easy
5. If you were going to use your library how would you use it?
6. When in doubt, leave it out “Simple things must be easy to build. Complex things might be hard to use” Some Karumi guy
7. No surprises
8. You can’t please everyone so aim to displease everyone equally
9. Case of study
10. CARumi 0.0.1
11. One good name is worth a thousand lines of code
12. CARumi 0.0.1
13. CARumi 0.0.5 carModel metersPerSecond metersPerSecond angleInRadians angleInRadians
14. Watch your exposure
15. CARumi 0.0.5
16. final private private private CARumi 0.1.0
17. Parenthesis ( ) How were you invoking Retrolambda? AFAIK it shouldn’t be possible to pass in a custom file system […] Nothing is final or hidden so I just subclassed Config and return what I want […] https:/ /github.com/orfjackal/retrolambda/pull/71
18. External classes* are (kind of) evil
19. CARumi 0.1.0
20. CARumi 0.2.0 CarModel model ThrottlePower power BrakePower power Rotation rotation Rotation rotation
21. CARumi 0.2.0 usage
22. Be graceful with your collections* input-> general output -> specific
23. CARumi 0.3.0
24. CARumi 0.3.5 List<Action> List<Action>
25. Hope for the best prepare for the worst
26. CARumi 0.5.0
27. Beautifying your API
28. CARumi 0.6.0
29. CARumi 0.6.0 usage
30. Versioning 2.0 (Semantic versioning)
31. MAJOR.MINOR.PATCH MAJOR breaking changes MINOR add functionality PATCH non observable changes
32. CARumi 1.0.0
33. Oops! We can merge turnLeft and turnRight
34. CARumi 1.1.0
35. CARumi 2.0.0
36. This is only the beginning
37. Lead by example
38. 1. Passes the tests 2. Reveals intention 3. No duplication 4. Fewest elements
39. Working with your repository
40. Centralized workflow Repository Collaborator Collaborator Collaborator
41. Reviewer Forking workflow Repository Collaborator Forked repository FORK PULL REQUEST Reviewer
42. Help wanted!
43. Public has a fuzzy meaning
44. Questions?
45. Thank you!
46. Find me! @serchinastico sergio@karumi.com https:/ /github.com/serchinastico