-
-
Notifications
You must be signed in to change notification settings - Fork 8.7k
[docs] ADR implementation updates - track by PR number, clarify PR body vs ADR, tracking status by issue #17697
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
titusfortner
wants to merge
11
commits into
trunk
Choose a base branch
from
adr_template
base: trunk
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+130
−33
Open
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
68cbfff
[docs] number ADRs by PR and track binding convergence in an issue
titusfortner 8e7cae9
[docs] link ADR tracking to the new-issue form, not the template source
titusfortner 1f202c3
[docs] clarify ADR scope: group related choices, keep records out of …
titusfortner 765981f
[docs] add ADR pull-request template and document its use
titusfortner 533e2fb
[docs] add optional current-behavior table to ADR Context
titusfortner 18c53ab
[docs] drop AI-assistance section from ADR PR template
titusfortner 3754bd8
[docs] ground ADR PR template in real usage: related links and TLC di…
titusfortner e73163a
[docs] move ADR PR template guidance into a comment
titusfortner cfc4db1
[docs] add reader-facing intro and proposal notes to ADR PR template
titusfortner 532550c
[docs] reorder ADR PR template; frame contention as discussion questions
titusfortner c9d4efa
Merge branch 'trunk' into adr_template
diemol File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| name: 📋 ADR Implementation Tracking | ||
| description: Track per-binding convergence on an accepted design decision record (ADR) | ||
| title: "[📋 ADR]: " | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Open this issue when a design decision record is **Accepted**. It tracks each binding's | ||
| progress toward implementing the decision so the committed record stays immutable. | ||
| Link it from the record's PR. See [docs/decisions/README.md](https://github.com/SeleniumHQ/selenium/blob/trunk/docs/decisions/README.md). | ||
|
|
||
| - type: input | ||
| id: record | ||
| attributes: | ||
| label: Decision record | ||
| description: Link to the accepted record and its PR (the record number is the PR number). | ||
| placeholder: "docs/decisions/NNNN-title.md (#NNNN)" | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: bindings | ||
| attributes: | ||
| label: Binding implementation | ||
| description: | | ||
| Replace each placeholder with the implementing PR and check the box when it merges. | ||
| Mark a binding `n/a` with a note if the decision does not apply to it. | ||
| value: | | ||
| - [ ] Java — _PR_ | ||
| - [ ] Python — _PR_ | ||
| - [ ] Ruby — _PR_ | ||
| - [ ] .NET — _PR_ | ||
| - [ ] JavaScript — _PR_ | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: notes | ||
| attributes: | ||
| label: Notes | ||
| description: Anything blocking convergence, or per-binding caveats discovered during implementation. | ||
| validations: | ||
| required: false | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| <!-- Proposing an ADR (see docs/decisions/README.md). Don't restate the decision here; keep this | ||
| body to proposal notes and review logistics. Rename the record file to NNNN-short-title.md | ||
| using this PR's number before merge. --> | ||
|
|
||
| 📄 The decision, its rationale, considered options, and consequences are in the record file | ||
| this PR adds; read it there. The sections below are proposal notes and review logistics. | ||
|
|
||
| ### 🔗 Related | ||
|
|
||
| <!-- Link any ADRs this depends on, builds on, competes with, or supersedes; reference | ||
| implementations or code PRs; and prior discussions or design docs. Omit if none. --> | ||
|
|
||
| ### 📝 Proposal notes | ||
|
|
||
| <!-- Notes about the proposal, not the decision: why these choices are grouped into one record, | ||
| what is deliberately deferred or out of scope, and any follow-on proposals. --> | ||
|
|
||
| ### 🗣 Discussion | ||
|
|
||
| <!-- Open questions you'd like reviewers or the TLC to weigh in on (frame them as questions for | ||
| input, not as defects), and the outcome of the TLC meeting(s) where this was discussed. --> | ||
|
|
||
| ### 📌 Tracking | ||
|
|
||
| <!-- Filled in on acceptance: open the ADR tracking issue and link it here. --> | ||
| Tracking issue: _(linked on acceptance)_ |
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. Adr filename placeholder mismatch
🐞 Bug⚙ MaintainabilityAgent Prompt
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools