Skip to content

Conversation

@kmcfaul
Copy link
Contributor

@kmcfaul kmcfaul commented Feb 3, 2026

What: Closes patternfly/pf-roadmap#287

Updates the template slightly to ask for more relevant data and any deadline to help with prioritization and sizing.

Summary by CodeRabbit

  • Chores
    • Updated feature request template with enhanced guidance covering error handling, accessibility considerations, keyboard interactions, and responsive design examples across viewports. Updated design tool references for better workflow alignment.

@coderabbitai
Copy link

coderabbitai bot commented Feb 3, 2026

Walkthrough

Updated the GitHub feature request issue template with expanded guidance on error handling, keyboard interactions, accessibility considerations, and visual examples across multiple viewport sizes, while changing the design tool reference from Marvel to Figma.

Changes

Cohort / File(s) Summary
Feature Request Template
.github/ISSUE_TEMPLATE/feature_request.md
Enhanced feature request template with additional requirements for error handling, accessibility considerations, keyboard/focus management questions, visual examples for different states and viewports, tool reference update (Marvel → Figma), and new product/release date targeting prompt.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

🚥 Pre-merge checks | ✅ 3 | ❌ 2
❌ Failed checks (2 warnings)
Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The pull request modifies a GitHub issue template, but the linked issue #287 requires changes to test approaches using Enzyme shallow rendering. These are fundamentally different work items. Verify the correct issue is linked. If issue #287 is incorrect, link the appropriate template-related issue. If this is the right PR, it does not address the Enzyme testing requirements in #287.
Out of Scope Changes check ⚠️ Warning The PR updates the feature request template as described, which aligns with the PR description stating it closes issue #287 and improves the template. However, this work does not match the stated objective of issue #287 about Enzyme testing approaches. Clarify whether the feature template update is the correct work for issue #287 or if a different issue should be linked. The current mismatch suggests either the wrong issue is referenced or the PR description is inaccurate.
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title accurately describes the main change: updating the feature request template with improved guidance and validation prompts.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@kmcfaul
Copy link
Contributor Author

kmcfaul commented Feb 3, 2026

Repos lacking any issue templates:
chatbot
data-view
doc-core
component-groups
quickstarts
design-tokens
catalog-view
log-viewer
react-virtualized
user-feedback
react-console
infra-issues

Of these, chatbot, data-view and component-groups may be the most useful to add in a template for as they are more commonly used.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
.github/ISSUE_TEMPLATE/feature_request.md (1)

1-23: ⚠️ Potential issue | 🔴 Critical

Critical inconsistency: PR linked to wrong issue.

The PR claims to close issue #287, which is about Enzyme testing approaches and shallow rendering. However, this PR updates a GitHub feature request template with questions about error handling, visuals, accessibility, and release dates—completely unrelated to testing methodology.

Please verify whether:

  • This PR should link to a different issue about improving the feature request template, or
  • The PR description needs correction
🤖 Fix all issues with AI agents
In @.github/ISSUE_TEMPLATE/feature_request.md:
- Line 21: Replace the misspelled word in the user-facing template line "Are
there any specific accessiblity considerations?" by changing "accessiblity" to
"accessibility" so the sentence reads "Are there any specific accessibility
considerations?" and ensure any other occurrences of "accessiblity" in the same
template are corrected as well.


**Any other information?**
Does this feature require keyboard interaction or focus management?
Are there any specific accessiblity considerations?
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix spelling error in user-facing template.

The word "accessiblity" is misspelled and should be "accessibility". This is user-facing text in the issue template.

📝 Proposed fix for the spelling error
-Are there any specific accessiblity considerations?
+Are there any specific accessibility considerations?
📝 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.

Suggested change
Are there any specific accessiblity considerations?
Are there any specific accessibility considerations?
🧰 Tools
🪛 LanguageTool

[grammar] ~21-~21: Ensure spelling is correct
Context: ...ocus management? Are there any specific accessiblity considerations? **If applicable, what ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 Prompt for AI Agents
In @.github/ISSUE_TEMPLATE/feature_request.md at line 21, Replace the misspelled
word in the user-facing template line "Are there any specific accessiblity
considerations?" by changing "accessiblity" to "accessibility" so the sentence
reads "Are there any specific accessibility considerations?" and ensure any
other occurrences of "accessiblity" in the same template are corrected as well.

@kmcfaul
Copy link
Contributor Author

kmcfaul commented Feb 3, 2026

Other additional questions that could be useful to add, but felt too specific to include for a template / made the template feel too long are listed below. Some of these questions may be useful when thinking about an issue for sizing at least.

Design
Any new design tokens or svgs?
Is there any required CSS work / link to core issue?

Behavior
Any applicable states or variants? Error states?
Any expected props, callbacks or user hooks?
Any known components or sub components to use as a foundation?

Accessibility and interaction
Does the feature have any animations?

Definition of done (section in general, maybe more for a PR template?)
unit tests
documentation/examples

Misc
Any portal component aspects like modal/tooltip?
What is the breaking change risk?
Any product team attached to the request?

@patternfly-build
Copy link
Collaborator

patternfly-build commented Feb 3, 2026

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

GH: issue template audit

2 participants