@avi2dg/checks 0.71.0 → 0.72.0

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 Every release of `@avi2dg/checks`, newest first, written by the release from its conventional commits.
 
+## 0.72.0
+
+Released 2026-11-07.
+
+### Features
+
+- **checks-setup:** write root AGENTS.md and CLAUDE.md when absent [#60](https://github.com/avi2d/checks/pull/60)
+
 ## 0.71.0
 
 Released 2026-11-07.

package/docs/gates/checks-setup.md

@@ -31,6 +31,7 @@ A `--private` run pins each job to `${{ vars.CI_RUNS_ON || 'ubuntu-latest' }}`.
 Setting the `CI_RUNS_ON` variable to a self-hosted runner label then lands the jobs there.
 A public run pins each job to `ubuntu-latest`.
 It copies each kit template under `dist/templates/` into `templates/`, so a new doc file starts from a copy there.
+It copies `dist/templates/agents.md` to `AGENTS.md` and `dist/templates/claude.md` to `CLAUDE.md` when the root lacks them, and keeps either file it finds.
 It names every file it wrote and every file it kept.
 It tells the owner to declare the repository owners in `package.json` `author` or `contributors` before the first commit.
 
@@ -69,6 +70,8 @@ checks-setup: set the CI_RUNS_ON variable to a self-hosted runner label so the n
 
 A repository owner runs it once in a new repository, before the first install.
 Declare the repository owners in `package.json` `author` or `contributors` before the first commit.
+Fill `AGENTS.md` with what an agent cannot infer from the code before the first commit.
+`checks-docs` fails on the unfilled placeholder entry until it is filled.
 Running it again with the same kit version changes nothing.
 A later kit release arrives through [Upgrade the kit](../how-to/upgrade-the-kit.md).
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@avi2dg/checks",
-  "version": "0.71.0",
+  "version": "0.72.0",
   "description": "Deterministic checks shared across a set of TypeScript repositories",
   "author": {
     "name": "avi2d",

package/src/delivery/setup.ts

@@ -130,11 +130,12 @@ const setupFile = Effect.fn("setupFile")(function* (root: string, relative: stri
   const full = path.join(root, relative);
   if (yield* system.exists(full)) {
     yield* Console.log(NAME + ": kept " + relative + ", already there");
-    return;
+    return false;
   }
   yield* system.makeDirectory(path.dirname(full), { recursive: true });
   yield* system.writeFileString(full, content);
   yield* Console.log(NAME + ": wrote " + relative);
+  return true;
 });
 
 const setupIgnore = Effect.fn("setupIgnore")(function* (root: string) {
@@ -352,10 +353,15 @@ const check = Effect.gen(function* () {
   for (const kind of Object.keys(TEMPLATES)) {
     yield* setupFile(root, "templates/" + kind + ".md", yield* kitText("dist/templates/" + kind + ".md"));
   }
+  const wroteAgents = yield* setupFile(root, "AGENTS.md", yield* kitText("dist/templates/agents.md"));
+  yield* setupFile(root, "CLAUDE.md", yield* kitText("dist/templates/claude.md"));
   if (isPrivate) yield* Console.log(NAME + ": set the CI_RUNS_ON variable to a self-hosted runner label so the new jobs land there");
   if (!outcome.hasOwner) {
     yield* Console.log(NAME + ": declare the repository owners in package.json author or contributors before the first commit");
   }
+  if (wroteAgents) {
+    yield* Console.log(NAME + ": fill AGENTS.md with what an agent cannot infer from the code before the first commit");
+  }
   return true;
 });