Skip to content

chore: invert CLAUDE.md/AGENTS.md so AGENTS.md is canonical#905

Merged
jdx merged 1 commit intomainfrom
chore/claude-md-symlink-agents
May 3, 2026
Merged

chore: invert CLAUDE.md/AGENTS.md so AGENTS.md is canonical#905
jdx merged 1 commit intomainfrom
chore/claude-md-symlink-agents

Conversation

@jdx
Copy link
Copy Markdown
Owner

@jdx jdx commented May 3, 2026

Summary

  • Makes AGENTS.md the canonical project agents file (was a symlink)
  • Replaces CLAUDE.md with a symlink to AGENTS.md (was the canonical file)

Test plan

  • readlink CLAUDE.md resolves to AGENTS.md
  • AGENTS.md is a regular file with the project instructions

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only change that swaps which agent-guidelines file is canonical; no runtime code paths are affected.

Overview
Agent guidelines source-of-truth is flipped. AGENTS.md is now the canonical file containing the full agent/development guidelines, and CLAUDE.md is replaced with a symlink-style pointer to AGENTS.md to avoid duplication.

Reviewed by Cursor Bugbot for commit c89afa6. Bugbot is set up for automated code reviews on this repo. Configure here.

@jdx jdx merged commit 66431c4 into main May 3, 2026
14 checks passed
@jdx jdx deleted the chore/claude-md-symlink-agents branch May 3, 2026 12:22
@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented May 3, 2026

Greptile Summary

This PR inverts the symlink relationship between AGENTS.md and CLAUDE.md: AGENTS.md is now the canonical regular file and CLAUDE.md is a symlink pointing to it. The content of the agent guidelines is unchanged.

Confidence Score: 5/5

Safe to merge — purely a symlink inversion with no content changes.

No logic, code, or content was modified; only the filesystem roles of the two Markdown files were swapped.

No files require special attention.

Important Files Changed

Filename Overview
AGENTS.md Promoted from symlink to canonical regular file; content is identical to the previous CLAUDE.md
CLAUDE.md Demoted from canonical regular file to a symlink pointing to AGENTS.md; no content changes

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    subgraph Before
        A1["CLAUDE.md (canonical file)"] -->|symlinked by| B1["AGENTS.md (symlink → ./CLAUDE.md)"]
    end
    subgraph After
        A2["AGENTS.md (canonical file)"] -->|symlinked by| B2["CLAUDE.md (symlink → AGENTS.md)"]
    end
Loading

Reviews (1): Last reviewed commit: "chore: invert CLAUDE.md/AGENTS.md so AGE..." | Re-trigger Greptile

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces AGENTS.md, a comprehensive guide for AI coding agents that details commit conventions, development commands, system architecture, and testing procedures. It also updates CLAUDE.md to point to this new documentation. A review comment correctly identified that the test subcommand was missing from the CLI documentation section, providing a suggestion to include it for consistency with later sections of the guide.

I am having trouble creating individual review comments. Click here to see my feedback.

AGENTS.md (118)

medium

The test subcommand is missing from the list of subcommands, although it is explicitly mentioned later in the document (lines 148 and 161) as a command for running tests (e.g., hk test --step <step_name>).

- Subcommands: init, install, uninstall, check, fix, run, validate, config, test

@jdx jdx mentioned this pull request May 3, 2026
jdx added a commit that referenced this pull request May 5, 2026
### 🚀 Features

- **(builtins)** add `buildifier` format and lint built-ins by
[@plx](https://github.com/plx) in
[#896](#896)

### 🐛 Bug Fixes

- **(step)** only auto-batch when rendered command exceeds ARG_MAX by
[@jdx](https://github.com/jdx) in
[#901](#901)

### 📚 Documentation

- thank Namespace for GitHub Actions runner support by
[@jdx](https://github.com/jdx) in
[#895](#895)

### 🔍 Other Changes

- **(ci)** use !cancelled() instead of always() for final job by
[@jdx](https://github.com/jdx) in
[#906](#906)
- **(docs)** remove shrill.en.dev analytics script by
[@jdx](https://github.com/jdx) in
[#903](#903)
- remove rust-cache from release jobs by [@jdx](https://github.com/jdx)
in [#893](#893)
- invert CLAUDE.md/AGENTS.md so AGENTS.md is canonical by
[@jdx](https://github.com/jdx) in
[#905](#905)
- set dev profile debug to 1 by [@jdx](https://github.com/jdx) in
[#907](#907)

### 📦️ Dependency Updates

- update anthropics/claude-code-action digest to fefa07e by
[@renovate[bot]](https://github.com/renovate[bot]) in
[#897](#897)
- update jdx/mise-action digest to 1648a78 by
[@renovate[bot]](https://github.com/renovate[bot]) in
[#898](#898)
- update apple-actions/import-codesign-certs action to v7 by
[@renovate[bot]](https://github.com/renovate[bot]) in
[#900](#900)
- update autofix-ci/action action to v1.3.4 by
[@renovate[bot]](https://github.com/renovate[bot]) in
[#899](#899)
- lock file maintenance by
[@renovate[bot]](https://github.com/renovate[bot]) in
[#908](#908)

### New Contributors

- @plx made their first contribution in
[#896](#896)

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Low Risk**
> Low risk release bookkeeping: primarily version string updates across
manifests and docs with no functional code changes in this diff.
> 
> **Overview**
> Updates the project for the `v1.45.0` release by bumping the crate/CLI
version (`Cargo.toml`, `Cargo.lock`, `hk.usage.kdl`, generated CLI docs)
and adding the `1.45.0` entry to `CHANGELOG.md`.
> 
> Refreshes documentation and example configs to reference the new
versioned Pkl package URLs (`docs/*.md`, `docs/public/*.pkl`,
`hk-example.pkl`).
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
cfe2da5. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Co-authored-by: mise-en-dev <[email protected]>
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