Skip to content

docs: add self-deleting first-time setup hint to AGENTS.md and CLAUDE.md #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TomKaltofen merged 1 commit into from
May 7, 2026
Merged

docs: add self-deleting first-time setup hint to AGENTS.md and CLAUDE.md #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
8 changes: 8 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Loading