[docs] ADR implementation updates - track by PR number, clarify PR body vs ADR, tracking status by issue#17697
[docs] ADR implementation updates - track by PR number, clarify PR body vs ADR, tracking status by issue#17697titusfortner wants to merge 11 commits into
Conversation
PR Summary by QodoNumber ADRs by PR and move binding convergence to tracking issues Description
Diagram
High-Level Assessment
Files changed (3)
|
Code Review by Qodo
Context used✅ Compliance rules (platform):
11 rules 1. ADR filename placeholder mismatch
|
|
Code review by qodo was updated up to the latest commit 1f202c3 |
|
Code review by qodo was updated up to the latest commit 533e2fb |
|
Code review by qodo was updated up to the latest commit 18c53ab |
|
Code review by qodo was updated up to the latest commit 3754bd8 |
|
Code review by qodo was updated up to the latest commit cfc4db1 |
|
Code review by qodo was updated up to the latest commit 532550c |
Proposes a public, static install on each binding's driver and service classes that downloads the driver and browser ahead of a session, warming the Selenium Manager cache without pinning paths or mutating options. Follows the ADR process refined in SeleniumHQ#17697. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
diemol
left a comment
There was a problem hiding this comment.
During the TLC meeting we decided we can merge this change.
| description: Link to the accepted record and its PR (the record number is the PR number). | ||
| placeholder: "docs/decisions/NNNN-title.md (#NNNN)" |
There was a problem hiding this comment.
1. Adr filename placeholder mismatch 🐞 Bug ⚙ Maintainability
The ADR tracking issue template uses the placeholder docs/decisions/NNNN-title.md, which conflicts with the documented ADR naming convention NNNN-short-title.md and can lead to incorrect record paths/links being copied into tracking issues. The ADR template also repeats the NNNN-title.md placeholder in the Superseded-by hint, reinforcing the same wrong pattern.
Agent Prompt
### Issue description
The ADR process documentation standardizes record filenames as `NNNN-short-title.md`, where `NNNN` is the PR number. However, the newly added tracking issue template and the ADR markdown template still suggest `NNNN-title.md`, which can be copy/pasted into issues/records and produce incorrect paths/links.
### Issue Context
- The README defines the canonical filename format.
- The tracking issue template and the ADR template both provide filename placeholders that should match that canonical format.
### Fix Focus Areas
- .github/ISSUE_TEMPLATE/adr-tracking.yml[15-18]
- docs/decisions/0000-template.md[1-8]
- docs/decisions/README.md[40-46]
### Suggested change
- Update placeholders from `NNNN-title.md` to `NNNN-short-title.md` (or to a more explicit placeholder like `NNNN-your-short-title.md`) everywhere they appear in templates/comments, so they match the README’s convention.
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
|
Code review by qodo was updated up to the latest commit c9d4efa |
🔗 Related Issues
Follow-up to #17665 (design decision record process).
💥 What does this PR do?
Refines the just-merged ADR process based on early experience writing records:
Accepted/Rejected/Superseded), so it stays immutable; the long-lived binding checklist lives in an issue. Adds an "ADR Implementation Tracking" issue form for it..github/PULL_REQUEST_TEMPLATE/adr.md) that points readers at the record and structures the body into related links, proposal notes, discussion, and tracking, documented in the README.Datefield from the template (git already tracks this).🔧 Implementation Notes
The scope and altitude wording directly answers recurring review feedback on draft ADRs: that records "bundle independently-adoptable decisions" and that they run implementation-heavy.
Tracking lives in a dedicated issue (linked from the record's PR) rather than the PR description, since the PR closes at merge while convergence continues for months.
🤖 AI assistance
💡 Additional Considerations
This is a process change to a just-merged TLC decision (#17665), so it should get TLC sign-off rather than a quiet merge.
🔄 Types of changes