From d13be54cb40dc080baed50baecec072132b86f5e Mon Sep 17 00:00:00 2001 From: Erich Blume Date: Sun, 19 Apr 2026 07:49:32 -0700 Subject: [PATCH] More CLAUDE.md -> AGENTS.md --- AGENTS.md | 12 ++++-------- README.md | 6 +++--- docs/tutorials/ai-assistance-guide.md | 2 +- 3 files changed, 8 insertions(+), 12 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 05f89ba..643bf40 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,4 +1,4 @@ -# CLAUDE.md +# AGENTS.md Guidance for Claude Code working in this repository. See also [[ai-assistance-guide]]. @@ -6,19 +6,15 @@ Guidance for Claude Code working in this repository. See also [[ai-assistance-gu **${REPO_NAME}** — ${REPO_DESCRIPTION} -**CRITICAL: Public repo — never commit secrets!** - -**Shell:** The user's shell is **fish**. Use `$status` not `$?` for exit codes. Use fish syntax in interactive examples. - ## First-Time Setup This repository is a **Forgejo template**. Most customization points are auto-resolved by Forgejo's template variable expansion when a new repo is created. The remaining manual steps are: -1. **Set `baseUrl`** in `docs/quartz.config.ts` — this is the hosted docs domain, not the repo URL +1. **Set `baseUrl`** in `docs/quartz.config.ts` — this is the hosted docs domain, not the repo URL. localhost if not hosted. 2. **Rename `.dagger/src/project_template_ci/`** directory to match your project, and update the class names inside -3. **Fill in project structure** in the `CLAUDE.md` Project Structure section +3. **Fill in project structure** in the `AGENTS.md` Project Structure section 4. **Fill in license info** in `README.md` -5. **When all TODOs are resolved:** delete this "First-Time Setup" section entirely from `CLAUDE.md` — it is only needed once +5. **When all TODOs are resolved:** delete this "First-Time Setup" section entirely from `AGENTS.md` — it is only needed once ## Rules diff --git a/README.md b/README.md index ff7b9d1..dd0575a 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ A personal project template with opinionated infrastructure for documentation, C - **Changelog** — [Towncrier](https://towncrier.readthedocs.io/) fragment-based changelog - **CI/CD** — [Dagger](https://dagger.io/) pipelines + [Forgejo](https://forgejo.org/) Actions workflow for releases - **Pre-commit hooks** — [prek](https://github.com/dustinblackman/prek) with linting, formatting, secret detection -- **AI assistance** — `CLAUDE.md` + structured docs for Claude Code (C0/C1/C2 change process, Mikado method) +- **AI assistance** — `AGENTS.md` + structured docs for Claude Code (C0/C1/C2 change process, Mikado method) - **Task runner** — [mise](https://mise.jdx.dev/) tasks for docs validation, Mikado chain management, and more ## Forking This Template @@ -19,9 +19,9 @@ After creating your repo, the remaining manual steps are: 1. Set `baseUrl` in `docs/quartz.config.ts` to your docs site domain 2. Rename `.dagger/src/project_template_ci/` directory and update class names to match your project -3. Fill in the project structure section in `CLAUDE.md` +3. Fill in the project structure section in `AGENTS.md` 4. Add license information to `README.md` -5. Remove the "First-Time Setup" section from `CLAUDE.md` and this section from `README.md` +5. Remove the "First-Time Setup" section from `AGENTS.md` and this section from `README.md` If you use Claude Code, it will prompt you to resolve remaining TODOs at the start of your first session. diff --git a/docs/tutorials/ai-assistance-guide.md b/docs/tutorials/ai-assistance-guide.md index 074c6dd..169844f 100644 --- a/docs/tutorials/ai-assistance-guide.md +++ b/docs/tutorials/ai-assistance-guide.md @@ -21,7 +21,7 @@ These are non-negotiable for AI agents working in this repo: 3. **Wait for user review before deploying** — Create PRs, don't auto-deploy 4. **Never merge PRs without explicit request** — The user merges after review -Full rules are in the repo's `CLAUDE.md`. See [[agent-change-process]] for the C0/C1/C2 change classification methodology — C0 (direct to main), C1 (feature branch + PR), C2 (Mikado Branch Invariant). +Full rules are in the repo's `AGENTS.md`. See [[agent-change-process]] for the C0/C1/C2 change classification methodology — C0 (direct to main), C1 (feature branch + PR), C2 (Mikado Branch Invariant). ## Workflow Conventions