docs: add interface boundary examples to implementation philosophy#42
Merged
bkrabach merged 1 commit intomicrosoft:mainfrom Jan 28, 2026
Merged
Conversation
Add good/bad examples for bypassing vs using public interfaces. Motivated by microsoft/amplifier-app-cli#70. 🤖 Generated with [Amplifier](https://github.com/microsoft/amplifier) Co-Authored-By: Amplifier <240397093+microsoft-amplifier@users.noreply.github.com>
720afbc to
ef098c2
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds good/bad examples to IMPLEMENTATION_PHILOSOPHY.md showing why bypassing public interfaces creates fragile code.
Motivation
This PR was motivated by microsoft/amplifier-app-cli#70 which demonstrates a "fix" that reaches into private internal state instead of using public APIs:
What's Added
Two new practical examples in the "Practical Examples" section:
Plus the key rule: If you can't do something through the public interface, the fix is to extend the interface—not bypass it.
Why IMPLEMENTATION_PHILOSOPHY.md
This is development-time guidance that belongs where developers look when making implementation decisions. The "Practical Examples" section already establishes the pattern of showing good vs bad approaches with code.
Related
🤖 Generated with Amplifier
Co-Authored-By: Amplifier 240397093+microsoft-amplifier@users.noreply.github.com