alunduil/zfs-replicate

CLAUDE.md redirects to AGENTS.md for Claude Code sessions

Open

#420 opened on Apr 23, 2026

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (5 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (24 stars)
PR merge metrics
 (PR metrics pending)

Description

User story

As a Claude Code user, I want CLAUDE.md to load automatically so that my session picks up repo conventions without me pasting them each time.

Why

Claude Code automatically loads CLAUDE.md from the repo root (and from ~/.claude/ for user-level preferences). Pointing it at AGENTS.md keeps a single source of truth while taking advantage of the convention.

Acceptance criteria

  • CLAUDE.md exists at the repo root.
  • Its body is a one-line redirect: See [AGENTS.md](./AGENTS.md) for repo conventions.
  • Any Claude-Code-specific guidance that does NOT belong in AGENTS.md (e.g., "prefer the Explore subagent for codebase searches", suggested .claude/settings.json permissions for this repo) is appended after the redirect.
  • File is covered by Vale in pre-commit (or explicitly excluded if under 5 lines).

Out of scope

  • Repo-specific .claude/settings.json (separate issue).
  • Content of AGENTS.md (separate issue).

Notes

  • Target release: none — chore
  • Depends on AGENTS.md landing first.
  • Source: modernization assessment §6.1.

Contributor guide

Research direction
Create a CLAUDE.md file at the repository root containing a one line redirect to AGENTS.md: 'See [AGENTS.md](./AGENTS.md) for repo conventions.' Optionally append any Claude Code specific guidance after the redirect.
Tech stack
None
Domain
documentationdeveloper experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95