From 54206be713c639fd729e8e78efbdfc37d61daeca Mon Sep 17 00:00:00 2001 From: Tom Kaltofen Date: Thu, 7 May 2026 08:21:45 +0000 Subject: [PATCH] docs: add self-deleting first-time setup hint to AGENTS.md and CLAUDE.md A fresh template clone needs the README "Setup Your Plugin" steps (rename placeholder/, edit pyproject.toml etc.). Today the agent instruction files don't mention this, so an AI agent jumps straight to uv sync / tox on an uninitialized repo. Add a top-of-file "First-time setup" section that detects an uninitialized template via the presence of placeholder/, points to the README setup steps, and instructs the agent to delete the section itself once setup is complete - so it only lives in fresh-template repos. --- AGENTS.md | 8 ++++++++ CLAUDE.md | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index f269e04..c3eb401 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,5 +1,13 @@ # AGENTS.md +## First-time setup + +If a `placeholder/` directory still exists in this repo, the template has not been initialized yet. Before doing any other work: + +1. Walk the user through `### Setup Your Plugin` in [README.md](README.md): rename `placeholder/` to their package name, update `pyproject.toml` (`name`, `authors`, `tool.setuptools.packages.find.include`, `tool.pytest.ini_options.testpaths`), update `.releaserc.yaml` (`message`, `repositoryUrl`), and replace `from placeholder.` imports in the 6 files listed in the README. +2. Verify with `uv venv && source .venv/bin/activate && uv sync --all-extras && tox`. +3. **Delete this `## First-time setup` section from both `CLAUDE.md` and `AGENTS.md`** — it only applies to fresh-template repos and would be misleading once the placeholder is gone. + Must read [README.md](README.md) first. This project uses the mloda framework. Assume any given task is related to mloda. diff --git a/CLAUDE.md b/CLAUDE.md index f269e04..c3eb401 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -1,5 +1,13 @@ # AGENTS.md +## First-time setup + +If a `placeholder/` directory still exists in this repo, the template has not been initialized yet. Before doing any other work: + +1. Walk the user through `### Setup Your Plugin` in [README.md](README.md): rename `placeholder/` to their package name, update `pyproject.toml` (`name`, `authors`, `tool.setuptools.packages.find.include`, `tool.pytest.ini_options.testpaths`), update `.releaserc.yaml` (`message`, `repositoryUrl`), and replace `from placeholder.` imports in the 6 files listed in the README. +2. Verify with `uv venv && source .venv/bin/activate && uv sync --all-extras && tox`. +3. **Delete this `## First-time setup` section from both `CLAUDE.md` and `AGENTS.md`** — it only applies to fresh-template repos and would be misleading once the placeholder is gone. + Must read [README.md](README.md) first. This project uses the mloda framework. Assume any given task is related to mloda.