-
Type:
Spec Change
-
Resolution: Fixed
-
Priority:
Unknown
-
None
-
Component/s: Cross Spec Consistency
-
None
-
Not Needed
Summary
Many spec changes require implementations in 2 drivers before merging. However, it's easy to forget that requirement when reviewing and merging spec PRs. It's also helpful for reviewers to see the two implementations to understand how the spec change maps to drivers. We should add checkboxes to the specifications PR template for the 1st and 2nd implementer to check. Additionally, we should add placeholders for the 1st and 2nd implementer drivers languages and links to the respective drivers PRs.
For example, add something like this:
[ ] 1st implementation completed and tests pass. <!-- 1st implementer language --> <!-- Link to 1st implementation PR --> [ ] 2nd implementation completed and tests pass. <!-- 2nd implementer language --> <!-- Link to 2nd implementation PR -->
Motivation
Who is the affected end user?
Drivers spec change implementers and reviewers.
How does this affect the end user?
Implementers can forget to wait for 1st and 2nd implementations before merging. Reviewers have to jump to the DRIVERS ticket and search for 1st and 2nd implementation links.
How likely is it that this problem or use case will occur?
The problem happens often enough for it to be annoying.
If the problem does occur, what are the consequences and how severe are they?
Mostly annoyance and mental overhead of keeping track of all the requirements of spec changes.
Is this issue urgent?
No.
Is this ticket required by a downstream team?
No.
Is this ticket only for tests?
No.
Acceptance Criteria
- Add checkboxes for the 1st and 2nd implementer to confirm the two implementations are complete before merging a spec change.
- Add placeholders to specify the 1st and 2nd implementer language, plus links to the respective implementation PRs.
- See the suggested format in the Summary section.
- Remove the existing checkbox "Test changes in at least one language driver." because it's replaced by the 1st and 2nd implementer checkboxes.
Note: The 1st implementer is usually the author of the spec change PR.