Skip to content

general: T8595: add CLAUDE.md#24

Merged
dmbaturin merged 6 commits into
currentfrom
T8595-add-claude-md
May 7, 2026
Merged

general: T8595: add CLAUDE.md#24
dmbaturin merged 6 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 2 minutes and 9 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: 6bbcfe1b-6e51-4de9-b714-090d82c23d01

📥 Commits

Reviewing files that changed from the base of the PR and between 624af08 and 35cca76.

📒 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.

@andamasov
Copy link
Copy Markdown
Member Author

@copilot review

@andamasov
Copy link
Copy Markdown
Member Author

@copilot review

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 29, 2026

@copilot review

Reviewed. Two factual inaccuracies corrected in 1cb9be0:

  1. Version noteconfigure.ac still says 1.1 (upstream autotools version hasn't been bumped), while debian/changelog is at 1.4. Both are now called out explicitly rather than just saying "Current source version 1.1".
  2. tests/ description — the directory contains both a libcheck C unit test (check_ipaddrcheck.c) and shell integration tests (assert.sh, integration_tests.sh); the previous entry only mentioned the former.

Everything else in the file checked out against the repo (directory layout, deps in configure.ac, build commands, conventions, mirror relationship).

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 29, 2026

@copilot review

Re-reviewed. CLAUDE.md is accurate as of 1cb9be0 — no new issues found. All sections (project purpose, tech stack, build commands, repository layout, cross-repo context, conventions, mirror relationship, contributor notes) match what's in the repo.

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

@dmbaturin dmbaturin merged commit dd0b518 into current May 7, 2026
1 of 2 checks passed
@vyosbot vyosbot added mirror-initiated This PR initiated for mirror sync workflow mirror-completed This PR has been mirrored successfully and removed mirror-initiated This PR initiated for mirror sync workflow labels May 7, 2026
@andamasov
Copy link
Copy Markdown
Member Author

Follow-up #26 opened to switch this repo from CLAUDE.md to AGENTS.md per the revised T8595 schema.

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

Labels

mirror-completed This PR has been mirrored successfully

Development

Successfully merging this pull request may close these issues.

4 participants