UN-3458 [MISC] Add dormant v2 PR template for spec compliance#1958
Open
muhammad-ali-e wants to merge 1 commit into
Open
UN-3458 [MISC] Add dormant v2 PR template for spec compliance#1958muhammad-ali-e wants to merge 1 commit into
muhammad-ali-e wants to merge 1 commit into
Conversation
Adds .github/pull_request_template_v2.md alongside the existing template. Source: Zipstack/review-context-framework with <product> -> unstract on lines 5 and 70. GitHub only auto-applies pull_request_template.md, so this new file is dormant — no behavior change for PR authors. Activation later is a rename (separate PR). Part of Epic UN-3459 (Review Context Framework adoption).
Contributor
Summary by CodeRabbit
WalkthroughA new GitHub pull request template file is added containing structured sections for implementation planning, testing evidence, risk assessment, and agent-generated spec compliance reporting. No functional code changes. ChangesPR Template Definition
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
|
| Filename | Overview |
|---|---|
| .github/pull_request_template_v2.md | Net-new dormant PR template markdown file; GitHub ignores any filename other than pull_request_template.md so no behavior change occurs. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[PR author opens PR] --> B{Which template filename?}
B -- pull_request_template.md current active --> C[GitHub auto-applies existing template]
B -- pull_request_template_v2.md dormant / this PR --> D[GitHub ignores file no behavior change]
C --> E[Current What/Why/How form shown to author]
D --> F[File sits unused until activation PR]
F --> G[Future activation PR git mv v2 to pull_request_template.md]
G --> H[Spec-compliance template becomes active]
H --> I[Reviewer agent cross-checks diff vs unstract-review-context spec repo]
Reviews (1): Last reviewed commit: "UN-3458 [MISC] Add dormant v2 PR templat..." | Re-trigger Greptile
|
Contributor
Test ResultsSummary
Runner Tests - Full Report
SDK1 Tests - Full Report
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/pull_request_template_v2.md:
- Line 3: Heading "Spec PR" uses H3 (###) immediately after the H1, causing an
MD001 heading-level jump; change the heading from "### Spec PR" to "## Spec PR"
(or insert a proper H2 before it) so the document follows incremental heading
levels and resolves the MD001 lint error.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 4bf1de58-cffd-43fb-a62f-142935ca09b6
📒 Files selected for processing (1)
.github/pull_request_template_v2.md
muhammad-ali-e
requested review from
athul-rs,
hari-kuriakose and
vishnuszipstack
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What
.github/pull_request_template_v2.mdalongside the existingpull_request_template.md.code_repo/.github/pull_request_template.md, with<product>→unstractsubstituted on lines 5 and 70.pull_request_template.mduntouched.Why
How
.github/pull_request_template_v2.md.pull_request_template.md— any other filename (includingpull_request_template_v2.md) is ignored. So this file is completely dormant; PR authors will see zero behavior change.Can this PR break any existing features. If yes, please list possible items. If no, please explain why. (PS: Admins do not merge the PR without this section filled)
pull_request_template.md. The addedpull_request_template_v2.mdis invisible to that logic — it sits in.github/as an unused file. No code paths, CI workflows, or reviewer flows depend on it.Database Migrations
Env Config
Relevant Docs
README.md,WAR_OF_THE_CONTEXTS.md,DORA.mdRelated Issues or PRs
Zipstack/unstract-cloud: https://github.com/Zipstack/unstract-cloud/pull/1490Dependencies Versions
Notes on Testing
<product>→unstractsubstitutions on lines 5 and 70.pull_request_template.mdis unchanged.Screenshots
N/A (no UI changes).
Checklist