feat: add child STP template for multi-SIG features#100
Merged
rnetser merged 5 commits intoRedHatQE:mainfrom May 5, 2026
Merged
feat: add child STP template for multi-SIG features#100rnetser merged 5 commits intoRedHatQE:mainfrom
rnetser merged 5 commits intoRedHatQE:mainfrom
Conversation
Add a dedicated template for child STPs (stps/stp-template/child-stp.md) that participating SIGs use when a feature spans multiple SIGs. The child template omits sections owned by the parent STP (Feature Overview, Feature Maturity, Enhancement links) and adds a Parent STP link for traceability. It keeps SIG-specific sections: scope, testing goals, scenarios, strategy, risks, and sign-off. Update AGENTS.md review checklist and docs/stp-guide.md to reference the new template. Signed-off-by: Ruth Netser <rnetser@redhat.com> Assisted-by: Claude <noreply@anthropic.com> Signed-off-by: rnetser <rnetser@redhat.com>
|
Report bugs in Issues Welcome! 🎉This pull request will be automatically processed with the following features: 🔄 Automatic Actions
📋 Available CommandsPR Status Management
Review & Approval
Testing & Validation
Cherry-pick Operations
Label Management
✅ Merge RequirementsThis PR will be automatically approved when the following conditions are met:
📊 Review ProcessApprovers and ReviewersApprovers:
Reviewers:
Available Labels
AI Features
💡 Tips
For more information, please refer to the project documentation or contact the maintainers. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdds explicit child-STP template compliance guidance to AGENTS.md and docs/stp-guide.md, and introduces a new ChangesSTP Compliance Rules
Child STP Template
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 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)
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. Review rate limit: 0/1 reviews remaining, refill in 60 minutes.Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
stps/stp-template/child-stp.md (1)
194-202: 🧹 Nitpick | 🔵 Trivial | ⚡ Quick winSign-off and approval: add explicit guidance for required approvers (QE Lead, PM, Dev Lead).
The template shows generic “Approvers” placeholders, but the repo guidance says approvers should include at minimum QE Lead, PM, Dev Lead (with no placeholder text remaining in the final STP). Consider adding a short instruction in the template to fill those specific roles.
✅ Proposed diff
### **IV. Sign-off and Approval** @@ * **Approvers:** - - [Name / `@github-handle`] + - [QE Lead Name / `@github-handle`] + - [PM Name / `@github-handle`] + - [Dev Lead Name / `@github-handle`]🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@stps/stp-template/child-stp.md` around lines 194 - 202, The "IV. Sign-off and Approval" section currently uses generic "Approvers" placeholders; update the child-stp.md template so the Approvers list explicitly requires QE Lead, PM, and Dev Lead (no placeholder text left) and add a short instruction to the template to populate names/handles for those roles; modify the "Approvers:" bullet under the section header to list QE Lead, Product Manager (PM), and Development Lead and remove the generic "[Name / `@github-handle`]" placeholders.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/stp-guide.md`:
- Around line 47-50: The guide says the child template "adds a `Parent STP`
link" but the template file `stps/stp-template/child-stp.md` only has a "See the
parent STP…" instruction; update the mismatch by adding an explicit metadata
field to the child template (e.g., a `Parent STP: [link]` front-matter/metadata
entry) in `child-stp.md`, or alternatively change the language in
`docs/stp-guide.md` to remove "adds a `Parent STP` link" and reflect the current
"See the parent STP…" behavior—pick one approach and make both files consistent
(referencing `stps/stp-template/child-stp.md` and `docs/stp-guide.md` to ensure
they match).
In `@stps/stp-template/child-stp.md`:
- Around line 67-70: Update the "API Extensions" checklist entry so it
explicitly requires only user-facing APIs: change the prompt under the "[x]
**API Extensions**" heading (the bullet starting "*List new or modified APIs:*")
to read something like "List new or modified user-facing APIs only (do not list
internal/component APIs — see parent STP for implementation details)"; keep the
testing-impact bullet as-is but ensure the wording enforces "user perspective
only" to avoid internal implementation leakage.
- Around line 82-89: The template's Testing Goals section lists P0 and P1 but
omits a P2 placeholder; add a third list item `- **[P2]** [SIG-specific testing
goal]` after the existing `- **[P1]**` line so child STP authors have a
"nice-to-have" tier; update the block containing the `- **[P0]**` and `-
**[P1]**` entries to include `- **[P2]**` with the same placeholder style.
- Around line 188-191: The template currently hardcodes Priority to "P0" and
embeds Tier inside the Test Scenario line; update Section III of child-stp.md so
each scenario has explicit, separate fields for Tier and Priority instead of a
fixed Priority value and an embedded Tier. Replace the single line "*Test
Scenario:* [Tier N] [Description]" with two fields such as "*Tier:* [Tier 1|Tier
2]" and "*Test Scenario:* [Description]" and change "*Priority:* P0" to
"*Priority:* [P0|P1|P2]" (keeping the placeholders so authors fill the correct
value).
---
Outside diff comments:
In `@stps/stp-template/child-stp.md`:
- Around line 194-202: The "IV. Sign-off and Approval" section currently uses
generic "Approvers" placeholders; update the child-stp.md template so the
Approvers list explicitly requires QE Lead, PM, and Dev Lead (no placeholder
text left) and add a short instruction to the template to populate names/handles
for those roles; modify the "Approvers:" bullet under the section header to list
QE Lead, Product Manager (PM), and Development Lead and remove the generic
"[Name / `@github-handle`]" placeholders.
🪄 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: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 5cd7ab40-7b77-4ac0-86d5-a2fc68359bc7
📒 Files selected for processing (3)
AGENTS.mddocs/stp-guide.mdstps/stp-template/child-stp.md
- Fix stp-guide.md: remove claim about 'Parent STP link' metadata field - API Extensions: specify 'user-facing APIs only' - Add P2 placeholder to Testing Goals - Test scenarios: separate Tier and Priority fields, don't hardcode P0 - Approvers: add QE Lead/PM/Dev Lead role placeholders Signed-off-by: Ruth Netser <rnetser@redhat.com> Assisted-by: Claude <noreply@anthropic.com> Signed-off-by: rnetser <rnetser@redhat.com>
rnetser
force-pushed
the
feat/child-stp-template
branch
from
099c5f7 to
e22418f
Compare
Contributor
Author
|
@coderabbitai[bot] The following review comments were reviewed and a decision was made:
|
|
Tip For best results, initiate chat on the files or code changes.
🧠 Learnings usedIf you found this review helpful, would you consider giving us a shout-out on X? Thank you for using CodeRabbit! |
Contributor
Author
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@stps/stp-template/child-stp.md`:
- Around line 171-182: Update the "#### **4. Risks**" section to require authors
to list all standard risk categories (use the existing "**[Risk Category]**"
placeholder) and for each either (a) document the SIG-specific risk plus
mitigation and include a sign-off, or (b) explicitly state a short justification
such as "Covered by parent STP" and omit the sign-off when there is no
SIG-specific risk — replace the sentence that tells authors to "omit categories
with no SIG-specific risk" with this deterministic instruction and preserve the
existing fields ("Risk", "Mitigation", "*[Category-specific field]:*",
"*Sign-off:*") so reviewers get consistent, unambiguous entries.
- Around line 185-193: The "III. Test Scenarios & Traceability" section
currently tells authors to list SIG test scenarios but omits a reminder that
regression tests should not be listed here; update the section titled "III. Test
Scenarios & Traceability" (and the Test Scenarios bullet/template) to add a
single-line note clarifying "Do not include regression tests here — place
regression test details in Test Strategy (II.2)" so authors correctly put
regression tests in II.2 and only SIG scenarios in III.
- Around line 137-139: Replace the current placeholder in Section II.2
"Monitoring" (the line '*Details:* [SIG-specific, or "Covered by parent STP"]')
with an explicit requirement that authors state whether alerts and/or metrics
are required; e.g., require fields like "Alerts required: Yes/No (describe alert
names, owners, thresholds)", "Metrics required: Yes/No (list required
SLIs/metrics and dashboards)", or "Covered by parent STP" if applicable, so the
template forces a clear statements about alerts and metrics.
- Around line 32-49: The child STP currently duplicates parent
requirements/acceptance criteria under the "SIG-Specific Requirements",
"SIG-Specific Acceptance Criteria", "Testability", and "Non-Functional
Requirements (NFRs)" sections; update the child-stp.md template so these
subsections do NOT restate parent text but instead reference parent artifacts
(e.g., "List Jira requirement IDs or parent STP section references this SIG
covers" or "Refer to parent acceptance criteria by ID — do not duplicate
wording"), or remove the redundant subsections entirely, ensuring the child
template only asks for SIG test scope, scenarios, and risks.
🪄 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: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 337ec051-c3e8-4f73-953a-86d078d46ab0
📒 Files selected for processing (2)
docs/stp-guide.mdstps/stp-template/child-stp.md
- Requirements: reference Jira IDs instead of restating parent text - Acceptance criteria: explicit 'do NOT duplicate parent' guidance - Monitoring: require stating whether alerts/metrics are needed - Test scenarios: add regression tests reminder Signed-off-by: Ruth Netser <rnetser@redhat.com> Assisted-by: Claude <noreply@anthropic.com> Signed-off-by: rnetser <rnetser@redhat.com>
EdDev
reviewed
May 3, 2026
RoniKishner
reviewed
May 3, 2026
Rename sections to match parent template naming: - 'SIG Scope' -> 'Feature Overview' (with child-specific comment) - 'I. SIG-Specific Review' -> 'I. Motivation and Requirements Review' - '1. SIG-Specific Requirements' -> '1. Requirement & User Story Review Checklist' - Re-add '4. Entry Criteria' with parent-deferral comment - Renumber Risks back to 5 Addresses EdDev's review: same structure, comments where child differs. Signed-off-by: Ruth Netser <rnetser@redhat.com> Assisted-by: Claude <noreply@anthropic.com> Signed-off-by: rnetser <rnetser@redhat.com>
- Remove 'Owning SIG', rename 'Participating SIG' to 'SIG' - Feature Overview: drop parent reference, ask SIG to describe scope - Acceptance Criteria: simplify to 'list or None', no Jira ID refs - API Extensions: add comment that new APIs belong in parent STP Signed-off-by: Ruth Netser <rnetser@redhat.com> Assisted-by: Claude <noreply@anthropic.com> Signed-off-by: rnetser <rnetser@redhat.com>
RoniKishner
approved these changes
May 4, 2026
Contributor
Author
|
/approve |
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
8 participants
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.
Summary
Add a dedicated template for child STPs (
stps/stp-template/child-stp.md) that participating SIGs use when a feature spans multiple SIGs.What's in the child template
The child template is a streamlined version of the parent STP template, tailored for participating SIGs:
Owning SIGandParticipating SIGto metadataSIG Scopesection (replaces Feature Overview — references the parent instead of duplicating it)Other changes
Reference
The existing child STP in the repo (
stps/sig-virt/heterogeneous-rhcos9-rhcos10/network.mdfrom PR #65) follows this pattern.Assisted-by: Claude noreply@anthropic.com
Summary by CodeRabbit