-
Notifications
You must be signed in to change notification settings - Fork 667
OCPBUGS-74178: Direct AI agents to AGENTS.md documentation hub #15938
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
sg00dwin
wants to merge
1
commit into
openshift:main
Choose a base branch
from
sg00dwin:OCPBUGS-74178-funnel-ai-to-agents
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+32
−207
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,20 @@ | ||
| # Cursor AI Configuration | ||
|
|
||
| This file contains Cursor-specific configuration and includes the shared AI context. | ||
| This file contains Cursor-specific configuration. | ||
|
|
||
| ## Shared AI Context | ||
| ## Primary AI Context | ||
|
|
||
| The primary AI context for this project is maintained in [../.ai/context.md](../.ai/context.md). This ensures consistency across different AI assistants (Claude, Cursor, etc.). | ||
| The primary AI entry point for this project is maintained in [AGENTS.md](AGENTS.md). | ||
|
|
||
| See [../.ai/README.md](../.ai/README.md) for more information about the AI context structure. | ||
| **AT SESSION STARTUP: Automatically read [AGENTS.md](AGENTS.md)** to understand project structure and workflows. | ||
|
|
||
| **REQUIRED: Before generating or modifying any code, you MUST:** | ||
| 1. Ensure you have current context from [AGENTS.md](AGENTS.md) | ||
| 2. Consult all relevant linked documentation files based on your task: | ||
| - [ARCHITECTURE.md](ARCHITECTURE.md) - Dynamic plugin SDK, extension points, module federation, public API boundaries | ||
| - [CONVENTIONS.md](CONVENTIONS.md) - Coding patterns, TypeScript/React/Go conventions, state management, hooks usage | ||
| - [TESTING.md](TESTING.md) - Jest/RTL unit tests, Cypress E2E tests, mocking strategies, test best practices | ||
| - [README.md](README.md) - Project setup, local development environment, building, running the console | ||
| - [CONTRIBUTING.md](CONTRIBUTING.md) - Git workflow, commit message format, PR process, backporting fixes | ||
| - [STYLEGUIDE.md](STYLEGUIDE.md) - File naming conventions, Go/SCSS/TypeScript formatting rules | ||
| - [INTERNATIONALIZATION.md](INTERNATIONALIZATION.md) - i18next usage, translation workflow, pseudolocalization, language support |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,20 @@ | ||
| # Claude Code AI Configuration | ||
|
|
||
| This file contains Claude-specific configuration and includes the shared AI context. | ||
| This file contains Claude-specific configurations and hooks. | ||
|
|
||
| ## Shared AI Context | ||
| ## Primary AI Context | ||
|
|
||
| The primary AI context for this project is maintained in [.ai/context.md](./.ai/context.md). This ensures consistency across different AI assistants (Claude, Cursor, etc.). | ||
| The primary AI entry point for this project is maintained in [AGENTS.md](AGENTS.md). | ||
|
|
||
| See [.ai/README.md](./.ai/README.md) for more information about the AI context structure. | ||
| **AT SESSION STARTUP: Automatically read [AGENTS.md](AGENTS.md)** to understand project structure and workflows. | ||
|
|
||
| **REQUIRED: Before generating or modifying any code, you MUST:** | ||
| 1. Ensure you have current context from [AGENTS.md](AGENTS.md) | ||
| 2. Consult all relevant linked documentation files based on your task: | ||
| - [ARCHITECTURE.md](ARCHITECTURE.md) - Dynamic plugin SDK, extension points, module federation, public API boundaries | ||
| - [CONVENTIONS.md](CONVENTIONS.md) - Coding patterns, TypeScript/React/Go conventions, state management, hooks usage | ||
| - [TESTING.md](TESTING.md) - Jest/RTL unit tests, Cypress E2E tests, mocking strategies, test best practices | ||
| - [README.md](README.md) - Project setup, local development environment, building, running the console | ||
| - [CONTRIBUTING.md](CONTRIBUTING.md) - Git workflow, commit message format, PR process, backporting fixes | ||
| - [STYLEGUIDE.md](STYLEGUIDE.md) - File naming conventions, Go/SCSS/TypeScript formatting rules | ||
| - [INTERNATIONALIZATION.md](INTERNATIONALIZATION.md) - i18next usage, translation workflow, pseudolocalization, language support |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
could we symlink context.md and CLAUDE.md to AGENTS.md to reduce duplicate documentation?