Skip to content

general: T8595: add CLAUDE.md#24

Closed
andamasov wants to merge 5 commits into
currentfrom
T8595-add-claude-md
Closed

general: T8595: add CLAUDE.md#24
andamasov wants to merge 5 commits into
currentfrom
T8595-add-claude-md

Conversation

@andamasov
Copy link
Copy Markdown
Member

@andamasov andamasov commented Apr 28, 2026

Summary

Adds a single source of truth for repo-level agent instructions, plus three symlinks so different agentic tools all read the same content from one canonical file.

Files added:

Path Type Consumed by
CLAUDE.md real file Claude Code, Anthropic agents
AGENTS.md symlink → CLAUDE.md tools that follow the AGENTS.md convention (e.g. OpenAI Codex)
.cursorrules symlink → CLAUDE.md Cursor
.github/copilot-instructions.md symlink → ../CLAUDE.md GitHub Copilot (docs)

Rationale

  • One source of truth — guidance lives in CLAUDE.md, the symlinks are zero-content. No drift between four files.
  • Each agentic tool reads its canonical filename and gets the same content.
  • Mac/Linux dev environments handle symlinks natively. Windows checkouts may render them as text files containing the target path; the canonical CLAUDE.md is unaffected and still rendered/served correctly by GitHub.

Out of scope

Path-specific Copilot instructions (.github/instructions/*.instructions.md) need YAML frontmatter (applyTo:) and target specific globs, so they cannot be symlinks. Not added here; they can be authored as separate small files per-repo if/when narrow path-scoped guidance is needed.

Tracked under T8595.

Test plan

  • CLAUDE.md renders on GitHub.
  • AGENTS.md, .cursorrules, .github/copilot-instructions.md resolve to CLAUDE.md content (readlink returns the right target).
  • CI passes.

🤖 Generated by robots

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 28, 2026

Warning

Rate limit exceeded

@andamasov has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 37 seconds before requesting another review.

To continue reviewing without waiting, purchase usage credits in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 9fe47e93-732b-458d-b449-90a5200fd09a

📥 Commits

Reviewing files that changed from the base of the PR and between d751342 and 332e02b.

📒 Files selected for processing (3)
  • .github/copilot-instructions.md
  • AGENTS.md
  • CLAUDE.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch T8595-add-claude-md
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch T8595-add-claude-md

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 28, 2026

👍
No issues in PR Title / Commit Title

@andamasov
Copy link
Copy Markdown
Member Author

@copilot review

@andamasov
Copy link
Copy Markdown
Member Author

@copilot review

Copy link
Copy Markdown

Copilot AI commented Apr 29, 2026

@copilot review

Review summary for general: T8595: add CLAUDE.md

The PR is a documentation-only change — it adds CLAUDE.md at the repo root and then strips the internal Confluence footer in the follow-up commit. A few observations:

Looks good ✅

  • All 10 workflow filenames listed in the Conventions section match the actual files in .github/workflows/ (including the chceck-pr-message.yml typo).
  • Build steps (./configuremakedpkg-buildpackage -us -uc) are correct for the autotools/Debian setup.
  • The note about GPL-3.0 vs GPL-2.0 linkage is accurate and useful for future contributors.
  • Dropping the internal.confluence.vyos.com link (commit 5146158) is the right call for a public file.

Minor nits (non-blocking)

  • "Bash 4.1 baseline" — worth adding the exact upstream tag (e.g. bash-4.1) so contributors can easily diff against it.
  • The Cross-repo context section refers to VyOS-Networks/vyos-build-packages/repos.toml; that org/path is accurate but vyos/vyos-build (canonical side) could also be cited directly.
  • No CI impact — nothing in the build or test pipeline reads CLAUDE.md.

Overall the file is accurate and useful. No code changes required from this review.

Copy link
Copy Markdown

Copilot AI commented Apr 29, 2026

@copilot review

The review I posted above still applies — no changes to the PR since then. Summary: the CLAUDE.md content is accurate (workflow filenames, build steps, licensing note all verified), and no code changes are required.

@andamasov
Copy link
Copy Markdown
Member Author

@copilot review

@andamasov andamasov marked this pull request as ready for review May 4, 2026 09:18
@andamasov
Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 6, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@andamasov
Copy link
Copy Markdown
Member Author

Closing in favor of vyos/vyatta-bash#26 under T8595.

Schema changed: AGENTS.md is now the tool-neutral primary instructions file. .github/copilot-instructions.md is a symlink to ../AGENTS.md (verified working with Copilot code review). No CLAUDE.md, no .cursorrules — both tools fall back to AGENTS.md natively.

@andamasov andamasov closed this May 7, 2026
@andamasov andamasov deleted the T8595-add-claude-md branch May 7, 2026 11:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Development

Successfully merging this pull request may close these issues.

2 participants