[adr] BiDi is an implementation mechanism, not a public API#17670
Open
titusfortner wants to merge 5 commits into
Open
[adr] BiDi is an implementation mechanism, not a public API#17670titusfortner wants to merge 5 commits into
titusfortner wants to merge 5 commits into
Conversation
Contributor
Code Review by Qodo
Context used✅ Compliance rules (platform):
11 rules 1. Option 3 ambiguous
|
Contributor
PR Summary by QodoAdd ADR process docs and record BiDi as internal implementation detail WalkthroughsDescription• Add an ADR/decision-record process, template, and approval rules under docs/decisions. • Record the decision that BiDi is internal and must not appear in supported public APIs. • Add a decisions index to make adopted proposals discoverable and citable. Diagramgraph TD
A([Contributor]) --> F[["docs/decisions/"]] --> B["ADR template"] --> C["BiDi ADR 0001"] --> D["Index"] --> E["Process README"]
subgraph Legend
direction LR
_p([Person]) ~~~ _dir[["Directory"]] ~~~ _doc["Document"]
end
High-Level AssessmentThe following are alternative approaches to this PR: 1. Use GitHub Discussions/Issues as the canonical decision log
2. Adopt an ADR tool/convention (e.g., adr-tools) with CLI automation
Recommendation: The current approach (plain Markdown ADRs with a lightweight documented process and a simple index) is the best fit here: it keeps the decision record close to the codebase, is language/tool neutral, and is easy for all binding maintainers to follow without introducing new tooling dependencies. File ChangesDocumentation (4)
|
Contributor
|
Code review by qodo was updated up to the latest commit 3d21495 |
nvborisenko
reviewed
Jun 17, 2026
|
|
||
| ## Decision | ||
|
|
||
| BiDi is an implementation mechanism, not a public API. New capabilities are exposed as |
Member
There was a problem hiding this comment.
Low-level API should be publicly available, it is power. But without warranties, spec is living doc. Not clear how to emphasize it per language. What I see: spec is trying to be not breaking changeable.
In .NET/C# we already funded a plan how to react on breaking changes. I really don't understand why low-level implementation should be internal.. .NET is ready for changes.
Member
There was a problem hiding this comment.
This low-level api will be accessible through the internal namespace, as mentioned below:
Everything in a BiDi namespace is internal: still reachable for
anything not yet wrapped, but not documented and subject to change without warning
Contributor
|
Code review by qodo was updated up to the latest commit 7b86053 |
Contributor
|
Code review by qodo was updated up to the latest commit d5fcb13 |
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
3 participants
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.
🔗 Related Issues
ADR process itself depends on #17665 merging
Decision
BiDi is an implementation mechanism, not a public API. New capabilities are exposed as
high-level, protocol-neutral APIs, idiomatic per language, subject to our standard
deprecation policy. Everything in a BiDi namespace is internal: still reachable for
anything not yet wrapped, but not documented and subject to change without warning.
A binding conforms when:
Considered options