Improve API review process: Difference between revisions

Latest revision as of 15:42, 30 November 2023

API vs header review? Our header review has become an API review – or even an implementation review!
API design used to be: Go talk with Jasmine; but that doesn't scale. Do we need a group of reviewers?
How can we get people involved with API design earlier?
- tooling might help – Daniel has a bot for flagging changes
- add checks for common mistakes (boolean trap, naming of getters)
- but tooling won't solve a social issue

@@ Line 9: / Line 9: @@
 ==Notes==
-- API vs header review? Our header review has become an API review – or even an implementation review!
+* API vs header review? Our header review has become an API review – or even an implementation review!
-- API design used to be: Go talk  with Jasmine; but that doesn't scale. Do we need a group of reviewers?
+* API design used to be: Go talk  with Jasmine; but that doesn't scale. Do we need a group of reviewers?
-- How can we get people involved with API design earlier?
+* How can we get people involved with API design earlier?
-  + tooling might help – Daniel has a  bot for flagging changes
+** tooling might help – Daniel has a  bot for flagging changes
-  + add checks for common mistakes (boolean trap, naming of getters)
+** add checks for common mistakes (boolean trap, naming of getters)
-  + but tooling won't solve a social issue
+** but tooling won't solve a social issue