Skip to content

Commit

Permalink
MINOR: Update coding guide to mention need to maintain public client …
Browse files Browse the repository at this point in the history
…API compatibility

Previously, the coding guide would imply that it's acceptable to break API compatibility due to the project's early stage in maturity. For years now, the project has been mature and adopted enough to warrant not breaking API compatibility.
  • Loading branch information
stanislavkozlovski committed Oct 29, 2021
1 parent eafe018 commit cec97c2
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion coding-guide.html
Expand Up @@ -100,7 +100,7 @@ <h2>Client Code</h2>
<p>There are a few things that need to be considered in client code that are not a major concern on the server side.</p>
<ul>
<li>Libraries needed by the client should be avoided whenever possible. Clients are run in someone else's code and it is very possible that they may have the same library we have, but a different and incompatible version. This will mean they can't use our client. For this reason the client should not use any libraries that are not strictly necessary.</li>
<li>We should attempt to maintain API compatibility when possible, though at this point in the project's lifecycle it is more important to make things good rather than avoid breakage.</li>
<li>We should maintain API compatibility. Any incompatible changes should be ultimately settled in the KIP design process, where the usual strategy is to the old APIs, mark them as deprecated and potentially remove them in some next major release.</li>
</ul>

<h2>Streams API</h2>
Expand Down

0 comments on commit cec97c2

Please sign in to comment.