-
Notifications
You must be signed in to change notification settings - Fork 624
UN-3458 [MISC] Add dormant v2 PR template for spec compliance #1958
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
muhammad-ali-e
wants to merge
1
commit into
main
Choose a base branch
from
misc/UN-3458-MISC_add_v2_pr_template
base: main
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.
+128
−0
Open
Changes from all commits
Commits
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,128 @@ | ||
| # Context | ||
|
|
||
| ### Spec PR | ||
| <!-- Link to the merged spec repo PR that authorizes this work. This PR is blocked until the spec PR is merged. --> | ||
| Zipstack/unstract-review-context#____ | ||
|
|
||
| ### Summary | ||
| <!-- One paragraph describing what this implementation delivers. --> | ||
|
|
||
| ### Implementation Ticket | ||
| <!-- Link to the originating Jira ticket. --> | ||
|
|
||
| --- | ||
|
|
||
| # Implementation Plan | ||
|
|
||
| ## Exit Criteria (Definition of Done) | ||
| <!-- What conditions must be true for this PR to be considered complete? --> | ||
|
|
||
| - [ ] All CI checks pass | ||
| - [ ] Acceptance criteria from spec PR verified | ||
| - [ ] Documentation updated (if applicable) | ||
| - [ ] No regressions introduced | ||
|
|
||
| ## Implementation Constraints | ||
| <!-- Are there any constraint exceptions being requested? If none, state "No exceptions requested." --> | ||
|
|
||
| ## Sequencing & Dependencies | ||
| <!-- Which PRs or branches must merge before this? Which PRs does this block? --> | ||
|
|
||
| - Depends on: #____ | ||
| - Blocks: #____ | ||
|
|
||
| ## Verification Plan | ||
| <!-- How is the correctness of this implementation validated? --> | ||
|
|
||
| - [ ] Unit tests added/updated | ||
| - [ ] Integration tests covering: ... | ||
| - [ ] Performance tests (if applicable): ... | ||
| - [ ] Manual verification steps: ... | ||
|
|
||
| ## Rollout Strategy | ||
| <!-- How does this change reach production safely? --> | ||
|
|
||
| - [ ] Feature flag: `flag_name` | ||
| - [ ] Migration required: [ ] reversible [ ] irreversible | ||
| - [ ] Canary / staged rollout plan: ... | ||
| - [ ] Monitoring / alerting in place for: ... | ||
|
|
||
| --- | ||
|
|
||
| # Testing Evidence | ||
|
|
||
| ## Test Results | ||
| <!-- Paste or link CI output, coverage reports, or manual test evidence. --> | ||
|
|
||
| ## Risk Assessment | ||
| <!-- What could go wrong with this change? How is that risk mitigated? --> | ||
|
|
||
| | Risk | Likelihood | Impact | Mitigation | | ||
| |------|------------|--------|------------| | ||
| | | | | | | ||
|
|
||
| --- | ||
|
|
||
| <!-- ================================================================== --> | ||
| <!-- BELOW THIS LINE IS AGENT-GENERATED. DO NOT EDIT. --> | ||
| <!-- The reviewer agent compiles this section automatically by --> | ||
| <!-- cross-checking the PR diff against Spec Compliance artifacts in --> | ||
| <!-- the spec repo (unstract-review-context). --> | ||
| <!-- ================================================================== --> | ||
|
|
||
| # Spec Compliance Report | ||
|
|
||
| ## Verdict | ||
| <!-- PASS / CONFLICT DETECTED — escalated to @org/architects --> | ||
|
|
||
| ## Spec PR Linkage | ||
| <!-- Verified: spec PR merged / Missing / Mismatched --> | ||
|
|
||
| ## Compliance Checks | ||
|
|
||
| ### Product Requirements | ||
|
|
||
| #### Acceptance Criteria | ||
| <!-- Does the implementation satisfy the defined business behavior? --> | ||
|
|
||
| #### Scope Definition | ||
| <!-- Does the implementation stay within defined scope boundaries? --> | ||
|
|
||
| #### Non-Functional Requirements | ||
| <!-- Does the code meet performance, availability, and resource contracts? --> | ||
|
|
||
| #### Dependencies | ||
| <!-- Are all dependencies used in this PR present in the approved registry? --> | ||
|
|
||
| #### Assumptions & Constraints | ||
| <!-- Does the code violate any active assumptions or constraints? --> | ||
|
|
||
| ### Specification | ||
|
|
||
| #### Architecture Decision Records (ADRs) | ||
| <!-- Does the code conform to active architectural decisions? --> | ||
|
|
||
| #### API / Interface Contracts | ||
| <!-- Do request/response schemas match the approved contracts? --> | ||
|
|
||
| #### Data Model & State Ownership | ||
| <!-- Does the code respect entity ownership and state transition rules? --> | ||
|
|
||
| #### Failure Modes & Resilience | ||
| <!-- Are required resilience patterns (retries, timeouts, circuit breakers) present? --> | ||
|
|
||
| #### Security Considerations | ||
| <!-- Are trust boundaries, auth mechanisms, and privilege models respected? --> | ||
|
|
||
| #### Implementation Constraints | ||
| <!-- Does the code avoid forbidden patterns and follow required patterns? --> | ||
|
|
||
| ## Conflicts (if any) | ||
|
|
||
| | # | Artifact | File:Line | Violation | Severity | | ||
| |---|----------|-----------|-----------|----------| | ||
| | | | | | | | ||
|
|
||
| ## Recommendation | ||
| <!-- Resolve conflicts before re-requesting review. If any conflict requires --> | ||
| <!-- amending a Spec artifact, raise a new spec PR first. --> | ||
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.
Uh oh!
There was an error while loading. Please reload this page.