Add API Design review process
hlgr360 opened this issue · comments
Holger Reinhardt commented
We have now done a couple of API design reviews. We need to do a retro and come with an initial written down API design review process we ask teams to adhere to. This can include (but is not limited to):
- overall review process
- mandatory vs optional reviewers
- how issues should be raised and addressed
- clearly time boxing reviews
- provide motivation and 'how do you define and measure success' for API
- how can learnings from the review flow back to the style guide
- when is an API reviewed and can be implemented
Rainer Zehnle commented
Please read https://github.com/Haufe-Lexware/api-style-guide/blob/master/api-design-review-process.md.
I hope it goes in the right direction.