Skip to content

docs: add CLAUDE.md and AGENTS.md as symlinks to README.md - #89

Merged
xuezhaojun merged 2 commits into
open-cluster-management-io:mainfrom
xuezhaojun:unify-readme-claude-symlink-v2
Mar 20, 2026
Merged

docs: add CLAUDE.md and AGENTS.md as symlinks to README.md#89
xuezhaojun merged 2 commits into
open-cluster-management-io:mainfrom
xuezhaojun:unify-readme-claude-symlink-v2

Conversation

@xuezhaojun

@xuezhaojun xuezhaojun commented Mar 20, 2026

Copy link
Copy Markdown
Member

Summary

  • Add CLAUDE.md and AGENTS.md as symlinks to README.md for AI coding tool discovery (Claude Code, Codex, etc.)
  • Add paths-ignore to go-presubmit.yml and go-postsubmit.yml so build/test/e2e/image jobs are skipped when only documentation files are changed (.md, docs/, CHANGELOG/, LICENSE)

Details

Symlinks:

  • README.md remains the single source of truth
  • CLAUDE.md -> README.md (Claude Code)
  • AGENTS.md -> README.md (Codex/other agents)

CI paths-ignore covers:

  • **.md — all markdown files
  • docs/** — documentation directory
  • CHANGELOG/** — changelog files
  • LICENSE — license file

DCO check, release, and chart-upload workflows are not affected.

🤖 Generated with Claude Code

Add symlinks so AI coding tools (Claude Code, Codex, etc.) can
discover the project documentation automatically. README.md remains
the single source of truth.

Signed-off-by: Xue Zhao <zxue@redhat.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: acm-agent[bot] <acm-agent@noreply.local>
@openshift-ci
openshift-ci Bot requested a review from elgnay March 20, 2026 02:19
@openshift-ci

openshift-ci Bot commented Mar 20, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: xuezhaojun
Once this PR has been reviewed and has the lgtm label, please assign elgnay 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

Add paths-ignore to go-presubmit.yml and go-postsubmit.yml so that
build, test, e2e, and image jobs are not triggered when only markdown
files, docs, changelogs, or LICENSE are modified.

Signed-off-by: Xue Zhao <zxue@redhat.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: acm-agent[bot] <acm-agent@noreply.local>
@xuezhaojun
xuezhaojun merged commit ee20e44 into open-cluster-management-io:main Mar 20, 2026
6 checks passed
@xuezhaojun
xuezhaojun deleted the unify-readme-claude-symlink-v2 branch March 20, 2026 02:42
@codecov

codecov Bot commented Mar 20, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 68.94%. Comparing base (0028cac) to head (3215c5d).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #89   +/-   ##
=======================================
  Coverage   68.94%   68.94%           
=======================================
  Files           4        4           
  Lines         892      892           
=======================================
  Hits          615      615           
  Misses        243      243           
  Partials       34       34           
Flag Coverage Δ
unit 68.94% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant