Skip to content

NO-JIRA: /microcopy-review improvements#16026

Open
logonoff wants to merge 1 commit intoopenshift:mainfrom
logonoff:mo-money
Open

NO-JIRA: /microcopy-review improvements#16026
logonoff wants to merge 1 commit intoopenshift:mainfrom
logonoff:mo-money

Conversation

@logonoff
Copy link
Member

@logonoff logonoff commented Feb 13, 2026

  • Increased context of PatternFly and RH guidelines (reads whole directories now)
  • Fixed inline execution not working for detection of style guide txt
  • Check for age of style guide txt before using it

Summary by CodeRabbit

  • New Features

    • Enhanced style guide reference retrieval with automated search capabilities
    • Added validation checks for style guide currency with user guidance
    • Expanded reference sources including additional style guide materials
  • Updates

    • Streamlined reference organization and retrieval paths
    • Improved guidance workflow with dynamic content access options

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Feb 13, 2026
@logonoff
Copy link
Member Author

/label px-approved

@openshift-ci-robot
Copy link
Contributor

@logonoff: This pull request explicitly references no jira issue.

Details

In response to this:

  • Increased context of PatternFly and RH guidelines (reads whole directories now)
  • Fixed inline execution not working for detection of style guide txt
  • Check for age of style guide txt before using it

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci bot added the px-approved Signifies that Product Support has signed off on this PR label Feb 13, 2026
@logonoff
Copy link
Member Author

Tried this out and verified that it reads more files now before making a review

/verified by @logonoff

@openshift-ci-robot openshift-ci-robot added the verified Signifies that the PR passed pre-merge verification criteria label Feb 13, 2026
@openshift-ci-robot
Copy link
Contributor

@logonoff: This PR has been marked as verified by @logonoff.

Details

In response to this:

Tried this out and verified that it reads more files now before making a review

/verified by @logonoff

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci bot requested review from jhadvig and spadgett February 13, 2026 20:22
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Feb 13, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: logonoff
Once this PR has been reviewed and has the lgtm label, please assign therealjon for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci-robot
Copy link
Contributor

@logonoff: This pull request explicitly references no jira issue.

Details

In response to this:

  • Increased context of PatternFly and RH guidelines (reads whole directories now)
  • Fixed inline execution not working for detection of style guide txt
  • Check for age of style guide txt before using it

Summary by CodeRabbit

  • New Features

  • Enhanced style guide reference retrieval with automated search capabilities

  • Added validation checks for style guide currency with user guidance

  • Expanded reference sources including additional style guide materials

  • Updates

  • Streamlined reference organization and retrieval paths

  • Improved guidance workflow with dynamic content access options

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci-robot openshift-ci-robot removed the verified Signifies that the PR passed pre-merge verification criteria label Feb 13, 2026
@logonoff
Copy link
Member Author

/verified by @logonoff

@openshift-ci-robot
Copy link
Contributor

@logonoff: This PR has been marked as verified by @logonoff.

Details

In response to this:

/verified by @logonoff

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci-robot openshift-ci-robot added the verified Signifies that the PR passed pre-merge verification criteria label Feb 13, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 13, 2026

📝 Walkthrough

Walkthrough

The changes update a microcopy review skill configuration file to enhance how style guide references are accessed and utilized. The modification expands available automation tools and introduces a user prompt for detecting outdated IBM Style Guide versions (>2 years old). Step 3 retrieval logic replaces fixed references with comprehensive sources including PatternFly UX writing guides and Red Hat supplementary guidance, with dynamic content-design document retrieval instructions. Step 4 and related sections update source references accordingly. The final IBM Style Guide reference path is simplified from a longer relative path to ./references/ibm-style-guide.txt, with a net change of +39 and -12 lines.

🚥 Pre-merge checks | ✅ 3 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title refers to a real aspect of the changeset (improvements to the microcopy-review skill), but is overly broad and vague, lacking specificity about what improvements were made. Consider a more specific title that highlights the primary change, such as 'Add outdated style guide check and expand reference sources for microcopy-review' to better convey the main improvements.
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into main

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

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

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

Copy link
Contributor

@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

🤖 Fix all issues with AI agents
In @.claude/skills/microcopy-review/SKILL.md:
- Around line 96-97: Replace the grammatically incorrect phrase "whether if the
file is up to date by checking the copyright year" with a correct variant such
as "whether the file is up to date by checking the copyright year" (or use "if
the file is up to date..." consistently) in the SKILL.md text that contains the
phrase "whether if the file is up to date by checking the copyright year. If
outdated by more than two years, inform the user..." so the sentence reads
correctly.
🧹 Nitpick comments (2)
.claude/skills/microcopy-review/SKILL.md (2)

96-97: Clarify the copyright year extraction logic.

The step mentions "checking the copyright year" to determine if the file is outdated, but doesn't specify how to extract this year from the text file. The implementation should include:

  • Which pattern to search for (e.g., "Copyright © 2024" or similar)
  • How to handle multiple copyright years
  • Fallback behavior if no copyright year is found
💡 Suggested implementation guidance

Add explicit instructions after line 95:

**If status is EXISTS**: Read `.claude/skills/microcopy-review/references/ibm-style-guide.txt`. First, determine
whether the file is up to date by:
  1. Extract the copyright year by searching for patterns like "Copyright © YYYY" or "Copyright YYYY"
  2. Compare the extracted year with the current year (2026)
  3. If the difference is more than two years, mark as outdated
  4. If no copyright year is found, assume the file is outdated and prompt the user

If outdated, inform the user that the file may be outdated and use `AskUserQuestion` with the following prompt:

116-117: Consider varying sentence structure for readability.

Three successive sentences begin with "If". While functionally correct, varying the structure slightly improves flow.

✨ Optional readability improvement
-If user selects "Use it anyway": Proceed with the review using the existing file. If the user selects "Update file": Prompt
-the user to provide a new IBM Style Guide PDF using the same prompt as in the NOT FOUND case below.
+When the user selects "Use it anyway", proceed with the review using the existing file. When selecting "Update file", prompt
+the user to provide a new IBM Style Guide PDF using the same prompt as in the NOT FOUND case below.

As per coding guidelines, LanguageTool flagged repeated sentence beginnings.

- Increased context of PatternFly and RH guidelines (reads whole directories now)
- Fixed inline execution not working for detection of style guide txt
- Check for age of style guide txt before using it
@openshift-ci-robot openshift-ci-robot removed the verified Signifies that the PR passed pre-merge verification criteria label Feb 13, 2026
@logonoff
Copy link
Member Author

/verified by @logonoff

@openshift-ci-robot openshift-ci-robot added the verified Signifies that the PR passed pre-merge verification criteria label Feb 13, 2026
@openshift-ci-robot
Copy link
Contributor

@logonoff: This PR has been marked as verified by @logonoff.

Details

In response to this:

/verified by @logonoff

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Feb 13, 2026

@logonoff: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

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

Labels

jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. px-approved Signifies that Product Support has signed off on this PR verified Signifies that the PR passed pre-merge verification criteria

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants