Add user replay evidence guidance pack#689
Conversation
|
Warning Review limit reached
More reviews will be available in 43 minutes and 37 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
Walkthrough이 PR은 제품 플로우 태스크를 위한 새로운 Changesuser-replay-evidence 가이던스 팩 도입
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
Relay Review Round 1Verdict: CHANGES_REQUESTED
|
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 `@skills/relay-plan/scripts/task-profile.js`:
- Line 10: Add a concise explanatory comment above the PRODUCT_FLOW_PATTERN
constant that documents the three alternation groups and what each matches: (1)
phrases like "user/customer/product journey/flow" (handles optional space/dash
and pluralization), (2) specific flow keywords such as "onboarding", "checkout",
"sign-up", "login", "purchase", "profile", "search", "invite", "upload" with
optional "flow(s)" and hyphen/space variants, and (3) terms like
"screen-by-screen", "end-to-end", or "e2e" optionally followed by
"product/user/customer" and "flow/journey"; include a short example or two for
each group and note that the regex is case-sensitive or not (and any flags) so
future maintainers understand intent when updating PRODUCT_FLOW_PATTERN.
🪄 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: 2cdb82ec-15ae-4bcb-92e8-fba8469eb4b6
📒 Files selected for processing (6)
skills/relay-plan/references/guidance-packs.mdskills/relay-plan/references/task-profile.mdskills/relay-plan/scripts/task-profile.jstests/relay-plan/fixtures/task-profile/product-flow-done-criteria.mdtests/relay-plan/scripts/rubric-reference-contract.test.jstests/relay-plan/scripts/task-profile.test.js
| const SIZES = new Set(["S", "M", "L", "XL"]); | ||
| const TRUST_BOUNDARY_PATTERN = /\b(?:trust[- ]boundary|auth[- ]boundary|trust root|forge|forged|bypass|fail closed|gate-check|validate[- ]?(?:manifest|transition)|state transition|state-machine)\b/; | ||
| const STATE_MACHINE_PATTERN = /\b(?:state transition|state-machine|validate[- ]?transition|manifest state)\b/; | ||
| const PRODUCT_FLOW_PATTERN = /\b(?:user|customer|product)[ -]?(?:journey|flow)s?\b|\b(?:onboarding|checkout|sign[- ]?up|login|purchase|activation|booking|subscription|settings|profile|search|invite|upload)[ -]?flows?\b|\b(?:screen-by-screen|end-to-end|e2e)\s+(?:product|user|customer)?\s*(?:flow|journey)s?\b/; |
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick win
복잡한 정규식 패턴에 설명 주석을 추가하세요.
PRODUCT_FLOW_PATTERN은 3개의 교대 패턴으로 구성된 복잡한 정규식이지만 설명 주석이 없습니다. 코딩 가이드라인에 따르면 복잡한 로직에는 의미 있는 주석이 필요합니다. 각 교대 패턴이 감지하는 케이스를 설명하는 주석을 추가하여 유지보수성을 개선하세요.
💡 제안하는 주석 예시
+// Detect product/user flow keywords in Done Criteria/task signals:
+// 1. user/customer/product journey|flow (e.g., "user journey", "product-flow")
+// 2. Domain-specific flows (e.g., "onboarding", "checkout flow", "sign-up flow")
+// 3. Screen-by-screen descriptors (e.g., "end-to-end user flow", "e2e product journey")
const PRODUCT_FLOW_PATTERN = /\b(?:user|customer|product)[ -]?(?:journey|flow)s?\b|\b(?:onboarding|checkout|sign[- ]?up|login|purchase|activation|booking|subscription|settings|profile|search|invite|upload)[ -]?flows?\b|\b(?:screen-by-screen|end-to-end|e2e)\s+(?:product|user|customer)?\s*(?:flow|journey)s?\b/;📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| const PRODUCT_FLOW_PATTERN = /\b(?:user|customer|product)[ -]?(?:journey|flow)s?\b|\b(?:onboarding|checkout|sign[- ]?up|login|purchase|activation|booking|subscription|settings|profile|search|invite|upload)[ -]?flows?\b|\b(?:screen-by-screen|end-to-end|e2e)\s+(?:product|user|customer)?\s*(?:flow|journey)s?\b/; | |
| // Detect product/user flow keywords in Done Criteria/task signals: | |
| // 1. user/customer/product journey|flow (e.g., "user journey", "product-flow") | |
| // 2. Domain-specific flows (e.g., "onboarding", "checkout flow", "sign-up flow") | |
| // 3. Screen-by-screen descriptors (e.g., "end-to-end user flow", "e2e product journey") | |
| const PRODUCT_FLOW_PATTERN = /\b(?:user|customer|product)[ -]?(?:journey|flow)s?\b|\b(?:onboarding|checkout|sign[- ]?up|login|purchase|activation|booking|subscription|settings|profile|search|invite|upload)[ -]?flows?\b|\b(?:screen-by-screen|end-to-end|e2e)\s+(?:product|user|customer)?\s*(?:flow|journey)s?\b/; |
🤖 Prompt for 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.
In `@skills/relay-plan/scripts/task-profile.js` at line 10, Add a concise
explanatory comment above the PRODUCT_FLOW_PATTERN constant that documents the
three alternation groups and what each matches: (1) phrases like
"user/customer/product journey/flow" (handles optional space/dash and
pluralization), (2) specific flow keywords such as "onboarding", "checkout",
"sign-up", "login", "purchase", "profile", "search", "invite", "upload" with
optional "flow(s)" and hyphen/space variants, and (3) terms like
"screen-by-screen", "end-to-end", or "e2e" optionally followed by
"product/user/customer" and "flow/journey"; include a short example or two for
each group and note that the regex is case-sensitive or not (and any flags) so
future maintainers understand intent when updating PRODUCT_FLOW_PATTERN.
Source: Coding guidelines
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 618cee5dc4
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| const SIZES = new Set(["S", "M", "L", "XL"]); | ||
| const TRUST_BOUNDARY_PATTERN = /\b(?:trust[- ]boundary|auth[- ]boundary|trust root|forge|forged|bypass|fail closed|gate-check|validate[- ]?(?:manifest|transition)|state transition|state-machine)\b/; | ||
| const STATE_MACHINE_PATTERN = /\b(?:state transition|state-machine|validate[- ]?transition|manifest state)\b/; | ||
| const PRODUCT_FLOW_PATTERN = /\b(?:user|customer|product)[ -]?(?:journey|flow)s?\b|\b(?:onboarding|checkout|sign[- ]?up|login|purchase|activation|booking|subscription|settings|profile|search|invite|upload)[ -]?flows?\b|\b(?:screen-by-screen|end-to-end|e2e)\s+(?:product|user|customer)?\s*(?:flow|journey)s?\b/; |
There was a problem hiding this comment.
Include standalone checkout/onboarding signals
For product tasks that mention a journey type without the literal word flow—for example, “Update the checkout page so customers can pay…” or “Improve onboarding so a new user reaches the dashboard”—this pattern does not match, and the secondary surface/signal check also misses them unless they happen to include one of the narrow state/export/delete/retry terms. That contradicts the new pack’s documented “Use when” cases for onboarding and checkout, so relay-plan will omit user-replay-evidence on common user-visible product-flow tasks that the feature is meant to cover.
Useful? React with 👍 / 👎.
Relay Review Round 2Verdict: CHANGES_REQUESTED
|
Relay ReviewVerdict: LGTM |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: cdc174e4e2
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| if (change_type === "docs") return false; | ||
| if (PRODUCT_FLOW_PATTERN.test(text)) return true; |
There was a problem hiding this comment.
Exclude non-product change types from replay guidance
For test-, prompt-, or infrastructure-only tasks that mention a product journey, e.g. Update checkout flow regression coverage in tests/... without product behavior changes, change_type is not docs, so PRODUCT_FLOW_PATTERN still adds user-replay-evidence. That contradicts the new pack’s own “Do not use” boundary for tests/prompt/infra work with no changed product journey and causes relay-plan to inject irrelevant replay guidance into those dispatch prompts.
Useful? React with 👍 / 👎.
Summary
Verification
Closes #683
Refs #678
Summary by CodeRabbit
릴리스 노트
New Features
Documentation
Tests