Merged
Conversation
Contributor
📝 WalkthroughWalkthroughUpdates .gitignore with new AI assistant config ignores, adds AGENTS.md, removes the “Adding new runtime” section from docs/CONTRIBUTING.md, and adds expanded “Adding new runtime” and “AI Usage” guidance to docs/DEVELOPER_GUIDE.md with a formatting newline. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes ✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
|
The following are automatically added/executed:
Available user actions:
Supported labels{'/wip', '/cherry-pick', '/build-push-pr-image', '/hold', '/lgtm', '/verified'} |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (6)
.gitignore (1)
171-178: Clarify intent: ignore AGENT.md vs track AGENTS.md.This repo adds AGENTS.md (plural) to version control while ignoring AGENT.md (singular). If that singular filename isn’t used by your tools, consider removing it from .gitignore to avoid confusion; if it is, add a short comment explaining the difference.
# AI Assistant Config Files .cursor/ .clinerules/ -.roorules/ +.roorules/ # verify this is the intended tool directory -AGENT.md +AGENT.md # ignored intentionally; AGENTS.md is tracked as the canonical spec CLAUDE.md GEMINI.md QWEN.mdAGENTS.md (3)
1-4: Add a link to the AGENTS.md spec for quick reference.# Overview -This is a testing repo for OpenDataHub and OpenShift AI, an MLOps platform for OpenShift. +This is a testing repo for OpenDataHub and OpenShift AI—an MLOps platform for OpenShift. +It supports the open AGENTS.md format: https://agents.md/ The tests contained in the repo are high-level integration tests at the Kubernetes API level.
6-10: Tighten phrasing of the docs checklist.-At the start of each session, consider if you need to consult any of these files in order to answer: +At the start of each session, consider consulting: - [Guidelines for Getting Started](./docs/GETTING_STARTED.md) - [Developer Guide](./docs/DEVELOPER_GUIDE.md) - [Style Guide](./docs/STYLE_GUIDE.md)
13-19: Security wording: “exposing” not “filtering”.-- Keep security in mind: Avoid filtering sensitive information and running destructive commands. +- Keep security in mind: Avoid exposing sensitive information and avoid running destructive commands.docs/DEVELOPER_GUIDE.md (2)
185-189: Correct typos in comments.- "support_multi_default_queries": True|False, # Optioanl, if set to True, `default_query_model` should contains a dict with corresponding inference_type + "support_multi_default_queries": True|False, # Optional; if True, `default_query_model` should contain a dict keyed by `inference_type`
206-210: Subject–verb agreement and clarity in AI Usage.-2. We support [AGENTS.md](../AGENTS.md), an [open format](https://agents.md/) for guiding coding agents. If you use any proprietary tool that do not support `AGENTS.md` (e.g. Claude Code, Qwen Code, Gemini Code), you can create a symlink: +2. We support [AGENTS.md](../AGENTS.md), an [open format](https://agents.md/) for guiding coding agents. If you use any proprietary tool that does not support `AGENTS.md` (e.g., Claude Code, Qwen Code, Gemini Code), you can create a symlink: ```bash ln -s AGENTS.md CLAUDE.md</blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used**: Path: .coderabbit.yaml **Review profile**: CHILL **Plan**: Pro **💡 Knowledge Base configuration:** - MCP integration is disabled by default for public repositories - Jira integration is disabled by default for public repositories - Linear integration is disabled by default for public repositories You can enable these sources in your CodeRabbit configuration. <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 4b221f1e5a71a9dfb2b4d28ab6128cafa22a053a and 9acb812b6e3198b5c9a4414be0db0bbee1bc1682. </details> <details> <summary>📒 Files selected for processing (4)</summary> * `.gitignore` (1 hunks) * `AGENTS.md` (1 hunks) * `docs/CONTRIBUTING.md` (0 hunks) * `docs/DEVELOPER_GUIDE.md` (1 hunks) </details> <details> <summary>💤 Files with no reviewable changes (1)</summary> * docs/CONTRIBUTING.md </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 LanguageTool</summary> <details> <summary>AGENTS.md</summary> [style] ~7-~7: Consider a more concise word here. Context: ... you need to consult any of these files in order to answer: - [Guidelines for Getting Start... (IN_ORDER_TO_PREMIUM) --- [grammar] ~7-~7: There might be a mistake here. Context: ...t any of these files in order to answer: - [Guidelines for Getting Started](./docs/G... (QB_NEW_EN) --- [grammar] ~8-~8: There might be a mistake here. Context: ...nswer: - [Guidelines for Getting Started](./docs/GETTING_STARTED.md) - [Developer Guide](./docs/DEVELOPER_GUIDE.... (QB_NEW_EN) --- [grammar] ~9-~9: There might be a mistake here. Context: ...s/GETTING_STARTED.md) - [Developer Guide](./docs/DEVELOPER_GUIDE.md) - [Style Guide](./docs/STYLE_GUIDE.md) # S... (QB_NEW_EN) --- [grammar] ~12-~12: There might be a mistake here. Context: ...STYLE_GUIDE.md) # Specific Instructions - Avoid unnecessary complexity: Aim for th... (QB_NEW_EN) --- [grammar] ~13-~13: There might be a mistake here. Context: ...hat works, while keeping the code clean. - Avoid obvious comments: Only add comment... (QB_NEW_EN) --- [grammar] ~14-~14: There might be a mistake here. Context: ... explain especially complex code blocks. - Maintain code consistency: Follow existi... (QB_NEW_EN) </details> <details> <summary>docs/DEVELOPER_GUIDE.md</summary> [grammar] ~180-~180: There might be a mistake here. Context: ... ```bash tox ``` ## Adding new runtime To add a new runtime, you need to: 1. ... (QB_NEW_EN) --- [grammar] ~181-~181: There might be a mistake here. Context: ...ntime To add a new runtime, you need to: 1. Add a new file under [manifests](../util... (QB_NEW_EN) --- [grammar] ~204-~204: There might be a mistake here. Context: ...andalone.py) for an example ## AI Usage If using AI tooling to assist you in the... (QB_NEW_EN) </details> </details> </details> <details> <summary>🔇 Additional comments (1)</summary><blockquote> <details> <summary>.gitignore (1)</summary><blockquote> `171-173`: **Confirm tool directory name: `.roorules/` looks like a typo.** I’m not aware of an AI assistant that writes `.roorules/`. If intentional, ignore this. Otherwise, please correct to the intended directory name. </blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Contributor
Author
|
/verified |
dbasunag
previously approved these changes
Sep 3, 2025
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/DEVELOPER_GUIDE.md (1)
184-201: Fix schema typos, ambiguous keys, and close the code fence; use JSON object for headers/body.
- “Optioanl” → “Optional”; “should contains” → “should contain a dict keyed by inference_type”.
- Use “headers” (object) not “header” (string).
- Represent “body” as a JSON object, not a quoted string.
- The code block fence is opened but not closed.
- Use the correct fence language (json) for clarity.
Apply:
-```code - "support_multi_default_queries": True|False, # Optioanl, if set to True, `default_query_model` should contains a dict with corresponding inference_type - "default_query_model": { - "query_input": <default query to be sent to the model>, - "query_output": <expected output>, - "use_regex": True|False, # Optional, if set to True, `query_output` should be a regex - }, - "<query type, for example: all-tokens>": { - "<protocol, for example HTTP>": { - "endpoint": "<model endpoint>", - "header": "<model required headers>", - "body": '{<model expected body}', - "response_fields_map": { - "response_output": <output field in response>, - "response": <response field in response - optional>, - }, - }, -``` +```json +{ + "support_multi_default_queries": true | false, // Optional; if true, `default_query_model` should contain a dict keyed by `inference_type`. + "default_query_model": { + "query_input": "<default query to be sent to the model>", + "query_output": "<expected output>", + "use_regex": true | false // Optional; if true, `query_output` is a regex. + }, + "<query type, e.g., all-tokens>": { + "<protocol, e.g., HTTP>": { + "endpoint": "<model endpoint>", + "headers": { "<header-name>": "<value>" }, + "body": { "<expected request body>" }, + "response_fields_map": { + "response_output": "<field in response containing output>", + "response": "<entire response field - optional>" + } + } + } +} +```
🧹 Nitpick comments (4)
AGENTS.md (2)
6-10: Tighten phrasing and fix minor style nits in the “Documentation” section.
- Use “to answer” instead of “in order to answer.”
- Consider imperative, parallel bullets.
Apply:
-At the start of each session, consider if you need to consult any of these files in order to answer: +At the start of each session, consider whether you should consult any of these files to answer: - [Guidelines for Getting Started](./docs/GETTING_STARTED.md) - [Developer Guide](./docs/DEVELOPER_GUIDE.md) - [Style Guide](./docs/STYLE_GUIDE.md)
1-1: Optional: Title case section headers for consistency.Minor consistency polish with docs elsewhere.
Apply:
-# Overview +# OverviewAnd similarly consider “# Documentation” → “# Documentation” (unchanged) and “# Specific Instructions” → “# Specific instructions” or make all Title Case consistently across the repo.
docs/DEVELOPER_GUIDE.md (2)
203-203: Cross-reference example location using fully qualified path and brief context.Add a short note clarifying which fields the example demonstrates.
Apply:
-3. See [caikit_standalone](../utilities/manifests/caikit_standalone.py) for an example +3. See [utilities/manifests/caikit_standalone.py](../utilities/manifests/caikit_standalone.py) for a complete example of headers/body/response_fields_map usage.
204-210: Offer Windows-friendly alternative to symlink tip.Symlinks may require admin privileges or differ on Windows; add a fallback.
Apply:
```bash ln -s AGENTS.md CLAUDE.md+On Windows (PowerShell), you can use:
+powershell +cmd /c mklink CLAUDE.md AGENTS.md +</blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used**: Path: .coderabbit.yaml **Review profile**: CHILL **Plan**: Pro **💡 Knowledge Base configuration:** - MCP integration is disabled by default for public repositories - Jira integration is disabled by default for public repositories - Linear integration is disabled by default for public repositories You can enable these sources in your CodeRabbit configuration. <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 9acb812b6e3198b5c9a4414be0db0bbee1bc1682 and 8f7346bbade4dbf1ba01861cb31dc9e0adbc614e. </details> <details> <summary>📒 Files selected for processing (2)</summary> * `AGENTS.md` (1 hunks) * `docs/DEVELOPER_GUIDE.md` (1 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 LanguageTool</summary> <details> <summary>AGENTS.md</summary> [style] ~7-~7: Consider a more concise word here. Context: ... you need to consult any of these files in order to answer: - [Guidelines for Getting Start... (IN_ORDER_TO_PREMIUM) --- [grammar] ~7-~7: There might be a mistake here. Context: ...t any of these files in order to answer: - [Guidelines for Getting Started](./docs/G... (QB_NEW_EN) --- [grammar] ~8-~8: There might be a mistake here. Context: ...nswer: - [Guidelines for Getting Started](./docs/GETTING_STARTED.md) - [Developer Guide](./docs/DEVELOPER_GUIDE.... (QB_NEW_EN) --- [grammar] ~9-~9: There might be a mistake here. Context: ...s/GETTING_STARTED.md) - [Developer Guide](./docs/DEVELOPER_GUIDE.md) - [Style Guide](./docs/STYLE_GUIDE.md) # S... (QB_NEW_EN) --- [grammar] ~12-~12: There might be a mistake here. Context: ...STYLE_GUIDE.md) # Specific Instructions - Avoid unnecessary complexity: Aim for th... (QB_NEW_EN) --- [grammar] ~13-~13: There might be a mistake here. Context: ...hat works, while keeping the code clean. - Avoid obvious comments: Only add comment... (QB_NEW_EN) --- [grammar] ~14-~14: There might be a mistake here. Context: ... explain especially complex code blocks. - Maintain code consistency: Follow existi... (QB_NEW_EN) </details> <details> <summary>docs/DEVELOPER_GUIDE.md</summary> [grammar] ~180-~180: There might be a mistake here. Context: ... ```bash tox ``` ## Adding new runtime To add a new runtime, you need to: 1. ... (QB_NEW_EN) --- [grammar] ~181-~181: There might be a mistake here. Context: ...ntime To add a new runtime, you need to: 1. Add a new file under [manifests](../util... (QB_NEW_EN) --- [grammar] ~204-~204: There might be a mistake here. Context: ...andalone.py) for an example ## AI Usage If using AI tooling to assist you in the... (QB_NEW_EN) </details> </details> </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
| - Maintain code consistency: Follow existing code patterns and architecture. | ||
| - Maintain locality of behavior: Keep code close to where it's used. | ||
| - Make small, focused changes, unless explicitly asked otherwise. | ||
| - Keep security in mind: Avoid filtering sensitive information and running destructive commands. |
Contributor
There was a problem hiding this comment.
Correct the security guidance (“filtering” → “leaking”, avoid double-verb).
“Avoid filtering sensitive information” is likely the opposite of intent. Recommend “leaking” and remove repetition.
Apply:
-- Keep security in mind: Avoid filtering sensitive information and running destructive commands.
+- Keep security in mind: Avoid leaking sensitive information and avoid running destructive commands.📝 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
| - Keep security in mind: Avoid filtering sensitive information and running destructive commands. | |
| - Keep security in mind: Avoid leaking sensitive information and avoid running destructive commands. |
🤖 Prompt for AI Agents
In AGENTS.md around line 18, the guidance currently reads "Avoid filtering
sensitive information and running destructive commands" which uses the wrong
verb and a slightly awkward conjunction; change "filtering" to "leaking" and
rephrase to eliminate the double-verb awkwardness so it reads something like
"Avoid leaking sensitive information or running destructive commands" (or
equivalent concise wording) to correct intent and improve clarity.
dbasunag
approved these changes
Sep 3, 2025
|
Status of building tag latest: success. |
mwaykole
pushed a commit
to mwaykole/opendatahub-tests
that referenced
this pull request
Jan 23, 2026
* feat: add AGENTS.md * typos --------- Co-authored-by: Debarati Basu-Nag <dbasunag@redhat.com>
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
4 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.
Add AGENTS.md, an open format to guide AI coding agents
Merge criteria:
Summary by CodeRabbit
Documentation
Chores