eblume/project-template
Template
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

More CLAUDE.md -> AGENTS.md

Browse source
This commit is contained in:
Erich Blume 2026-04-19 07:49:32 -07:00
commit d13be54cb4
3 changed files with 8 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

12
AGENTS.md
View file

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

6
README.md
View file

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

2
docs/tutorials/ai-assistance-guide.md
View file

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