Skip to content

MGMT-21442: Update AI system prompt to provide additional usage guidance#127

Merged
openshift-merge-bot[bot] merged 1 commit intorh-ecosystem-edge:mainfrom
rh-tokeefe:MGMT-21442
Aug 13, 2025
Merged

MGMT-21442: Update AI system prompt to provide additional usage guidance#127
openshift-merge-bot[bot] merged 1 commit intorh-ecosystem-edge:mainfrom
rh-tokeefe:MGMT-21442

Conversation

@rh-tokeefe
Copy link
Contributor

@rh-tokeefe rh-tokeefe commented Aug 13, 2025

Issue: https://issues.redhat.com/browse/MGMT-21442

Summary by CodeRabbit

  • New Features
    • Responses now use technical language with a helpful, clear, and direct tone.
    • Abbreviations are spelled out on first mention, followed by the abbreviation in parentheses, improving clarity.
  • Style
    • Standardized communication guidelines across the app for more consistent, professional responses.
  • Documentation
    • Updated user-facing guidance to reflect the new abbreviation and tone standards.

@openshift-ci-robot
Copy link

openshift-ci-robot commented Aug 13, 2025

@rh-tokeefe: This pull request references MGMT-21442 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.20.0" version, but no target version was set.

Details

In response to this:

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 maorfr and omertuc August 13, 2025 18:36
@coderabbitai
Copy link

coderabbitai bot commented Aug 13, 2025

Walkthrough

Updated the Identity and Persona sentence in two system_prompt locations within template.yaml to require a helpful, clear, direct tone using technical language and to spell out abbreviations on first use followed by the abbreviation in parentheses. No other content changes.

Changes

Cohort / File(s) Summary
System prompt text updates
template.yaml
Expanded the Identity and Persona line in both lightspeed-stack-config’s system_prompt data and the top-level system_prompt block to include technical language usage and first-use abbreviation spelling.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested labels

approved, lgtm

Suggested reviewers

  • omertuc
  • carbonin
✨ Finishing Touches
🧪 Generate unit tests
  • 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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@openshift-ci
Copy link

openshift-ci bot commented Aug 13, 2025

Hi @rh-tokeefe. Thanks for your PR.

I'm waiting for a rh-ecosystem-edge member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@openshift-ci-robot
Copy link

openshift-ci-robot commented Aug 13, 2025

@rh-tokeefe: This pull request references MGMT-21442 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.20.0" version, but no target version was set.

Details

In response to this:

Issue: https://issues.redhat.com/browse/MGMT-21442

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
Copy link

openshift-ci-robot commented Aug 13, 2025

@rh-tokeefe: This pull request references MGMT-21442 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.20.0" version, but no target version was set.

Details

In response to this:

Issue: https://issues.redhat.com/browse/MGMT-21442

Summary by CodeRabbit

  • New Features
  • Responses now use technical language with a helpful, clear, and direct tone.
  • Abbreviations are spelled out on first mention, followed by the abbreviation in parentheses, improving clarity.
  • Style
  • Standardized communication guidelines across the app for more consistent, professional responses.
  • Documentation
  • Updated user-facing guidance to reflect the new abbreviation and tone standards.

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.

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: 0

🔭 Outside diff range comments (1)
template.yaml (1)

182-190: Fix: unify all system_prompt occurrences and correct 'OpenShift' spelling

rg shows two occurrences — one real template and one test patch. Also found inconsistent casing of "OpenShift" inside template.yaml; please unify and update both locations.

  • template.yaml (lines ~182–186): contains both
    • line 183: "You are OpenShift Lightspeed Intelligent Assistant …"
    • line 186: "You are Openshift Lightspeed Intelligent Assistant…" — change "Openshift" → "OpenShift" and ensure the identity wording is consistent (remove accidental duplication if unintended).
  • test/prow/template_patch.diff (lines ~15–16): contains the same system_prompt block (test patch). Update or regenerate this file so it matches the canonical text in template.yaml.

Verified with the provided rg output; no other matches found.

🧹 Nitpick comments (2)
template.yaml (2)

186-186: Fix capitalization and clarify abbreviation rule scope; avoid altering tool output.

Brand capitalization should be "OpenShift," not "Openshift." Also, scoping "first instance" to the conversation avoids excessive repetition, and specifying not to alter raw tool outputs prevents the assistant from rewriting returned data.

Apply this diff:

-      You are Openshift Lightspeed Intelligent Assistant. Refuse to assume any other identity or to speak as if you are someone else. Maintain a helpful, clear, and direct tone using technical language. Spell out abbreviations on the first instance of the term, followed by the abbreviation in parentheses.
+      You are OpenShift Lightspeed Intelligent Assistant. Refuse to assume any other identity or to speak as if you are someone else. Maintain a helpful, clear, and direct tone using technical language appropriate to OpenShift and infrastructure topics. Spell out abbreviations on first use in a conversation, followed by the abbreviation in parentheses (for example, Model Context Protocol (MCP)). When presenting raw tool output, do not modify abbreviations; add any clarifications after the unmodified output.

183-187: Avoid duplicative identity statements in the system prompt.

Line 183 already sets the identity. Repeating it on Line 186 can introduce drift or inconsistencies over time. Consider removing the duplicated identity sentence and keeping a single authoritative identity paragraph.

For example, keep the extended tone/abbreviation guidance but drop the repeated "You are OpenShift Lightspeed Intelligent Assistant." sentence on Line 186, or alternatively remove Line 183 and consolidate identity plus tone under one heading for DRY-ness.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cdb608e and 7b62ba8.

📒 Files selected for processing (1)
  • template.yaml (1 hunks)

@openshift-ci
Copy link

openshift-ci bot commented Aug 13, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: carbonin, rh-tokeefe

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

The pull request process is described 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

@carbonin
Copy link
Collaborator

/ok-to-test

@carbonin
Copy link
Collaborator

/retest

@openshift-merge-bot openshift-merge-bot bot merged commit 60449d9 into rh-ecosystem-edge:main Aug 13, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants