Skip to content

CONSOLE-4873: Add AI agent documentation #94

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.

Sign up for GitHub

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

Jump to bottom
Merged
openshift-merge-bot merged 1 commit into from
Jan 8, 2026
Merged

CONSOLE-4873: Add AI agent documentation #94

openshift-merge-bot merged 1 commit into from
Jan 8, 2026

Conversation

@TheRealJon
Copy link
Member

@TheRealJon TheRealJon commented Jan 7, 2026

Summary

  • Added AGENTS.md with comprehensive guidelines for AI coding assistants
  • Created CLAUDE.md symlink for compatibility with different AI tools
  • Included prominent warnings about template scope and downstream impact

Details

The documentation covers:

  • Project architecture (webpack module federation, dynamic plugin system)
  • Development workflow and tooling (yarn scripts, linting, testing)
  • Key constraints (i18n namespacing, CSS prefixing, module mapping)
  • Common tasks (adding pages, nav items, updating plugin name)
  • Build and deployment instructions

The warning section emphasizes that changes to this template repository should only include improvements intended as standard practice for ALL plugins, not plugin-specific features.

Test plan

  • Verify AGENTS.md renders correctly in GitHub
  • Verify CLAUDE.md symlink works correctly
  • Review documentation for accuracy and completeness

🤖 Generated with Claude Code

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

openshift-ci-robot commented Jan 7, 2026 •
edited by openshift-ci bot
Loading

@TheRealJon: This pull request references CONSOLE-4873 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 sub-task to target the "4.22.0" version, but no target version was set.

Details

In response to this:

Summary

  • Added AGENTS.md with comprehensive guidelines for AI coding assistants
  • Created CLAUDE.md symlink for compatibility with different AI tools
  • Included prominent warnings about template scope and downstream impact

Details

The documentation covers:

  • Project architecture (webpack module federation, dynamic plugin system)
  • Development workflow and tooling (yarn scripts, linting, testing)
  • Key constraints (i18n namespacing, CSS prefixing, module mapping)
  • Common tasks (adding pages, nav items, updating plugin name)
  • Build and deployment instructions

The warning section emphasizes that changes to this template repository should only include improvements intended as standard practice for ALL plugins, not plugin-specific features.

Test plan

  • Verify AGENTS.md renders correctly in GitHub
  • Verify CLAUDE.md symlink works correctly
  • Review documentation for accuracy and completeness

🤖 Generated with Claude Code

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 approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 7, 2026
jhadvig
jhadvig reviewed Jan 7, 2026
View reviewed changes
Copy link
Member

@jhadvig jhadvig left a comment

Choose a reason for hiding this comment

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

/lgtm

@jhadvig jhadvig added qe-approved Signifies that QE has signed off on this PR px-approved Signifies that Product Support has signed off on this PR docs-approved Signifies that Docs has signed off on this PR labels Jan 7, 2026
@openshift-ci-robot
Copy link

openshift-ci-robot commented Jan 7, 2026 •
edited by openshift-ci bot
Loading

@TheRealJon: This pull request references CONSOLE-4873 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 sub-task to target the "4.22.0" version, but no target version was set.

Details

In response to this:

Summary

  • Added AGENTS.md with comprehensive guidelines for AI coding assistants
  • Created CLAUDE.md symlink for compatibility with different AI tools
  • Included prominent warnings about template scope and downstream impact

Details

The documentation covers:

  • Project architecture (webpack module federation, dynamic plugin system)
  • Development workflow and tooling (yarn scripts, linting, testing)
  • Key constraints (i18n namespacing, CSS prefixing, module mapping)
  • Common tasks (adding pages, nav items, updating plugin name)
  • Build and deployment instructions

The warning section emphasizes that changes to this template repository should only include improvements intended as standard practice for ALL plugins, not plugin-specific features.

Test plan

  • Verify AGENTS.md renders correctly in GitHub
  • Verify CLAUDE.md symlink works correctly
  • Review documentation for accuracy and completeness

🤖 Generated with Claude Code

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 lgtm Indicates that a PR is ready to be merged. label Jan 7, 2026
@TheRealJon
Copy link
Member Author

TheRealJon commented Jan 7, 2026

/retest

@TheRealJon @claude
CONSOLE-4873: Add AI agent documentation
bd92fc4 
Add AGENTS.md with comprehensive guidelines for AI coding assistants working on this template repository. Include warnings about template scope and impact on downstream projects. Create CLAUDE.md symlink for compatibility.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Jan 7, 2026
@TheRealJon
Copy link
Member Author

TheRealJon commented Jan 7, 2026

/retest

@jhadvig
Copy link
Member

jhadvig commented Jan 8, 2026

Overriding since we are adding AI configuration.
/override ci/prow/e2e-aws-plugin-template

@openshift-ci
Copy link

openshift-ci bot commented Jan 8, 2026

@jhadvig: Overrode contexts on behalf of jhadvig: ci/prow/e2e-aws-plugin-template

Details

In response to this:

Overriding since we are adding AI configuration.
/override ci/prow/e2e-aws-plugin-template

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

openshift-ci bot commented Jan 8, 2026

@TheRealJon: 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.

jhadvig
jhadvig approved these changes Jan 8, 2026
View reviewed changes
Copy link
Member

@jhadvig jhadvig left a comment

Choose a reason for hiding this comment

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

/lgtm
/verified by @jhadvig

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jan 8, 2026
@openshift-ci
Copy link

openshift-ci bot commented Jan 8, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jhadvig, TheRealJon

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

@jhadvig jhadvig added the verified Signifies that the PR passed pre-merge verification criteria label Jan 8, 2026
@openshift-merge-bot openshift-merge-bot bot merged commit 76c1ba0 into openshift:main Jan 8, 2026
4 checks passed
@TheRealJon TheRealJon deleted the CONSOLE-4873 branch January 8, 2026 14:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jhadvig jhadvig jhadvig approved these changes

@christianvogt christianvogt Awaiting requested review from christianvogt

@florkbr florkbr Awaiting requested review from florkbr

Assignees

@jhadvig jhadvig

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. docs-approved Signifies that Docs has signed off on this PR jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. lgtm Indicates that a PR is ready to be merged. px-approved Signifies that Product Support has signed off on this PR qe-approved Signifies that QE has signed off on this PR verified Signifies that the PR passed pre-merge verification criteria

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@TheRealJon @openshift-ci-robot @jhadvig