[adr] BiDi is an implementation mechanism, not a public API#17670
[adr] BiDi is an implementation mechanism, not a public API#17670titusfortner wants to merge 6 commits into
Conversation
Code Review by Qodo
Context used✅ Compliance rules (platform):
11 rules 1. Missing ADR date
|
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)
|
|
Code review by qodo was updated up to the latest commit 3d21495 |
|
Code review by qodo was updated up to the latest commit 7b86053 |
|
Code review by qodo was updated up to the latest commit d5fcb13 |
|
Code review by qodo was updated up to the latest commit cdc95ab |
|
I agree with the rationale explained in this ADR. |
diemol
left a comment
There was a problem hiding this comment.
We decided in the TLC meeting that Titus will detail a bit more what conceptually means to have the BiDi code as internal and then we can move to approve this ADR.
📄 The decision, its rationale, considered options, and consequences are in the record file this
PR adds (
docs/decisions/17670-bidi-is-an-implementation-mechanism.md); read it there. Thesections below are proposal notes and review logistics.
🔗 Related
📝 Proposal notes
🗣 Discussion
📌 Tracking
Tracking issue: (linked on acceptance)