edkuksa/skills
1
0
Fork 0
mirror of https://github.com/mattpocock/skills.git synced 2026-07-29 02:52:42 +07:00
Code Issues Packages Projects Releases Wiki Activity

Put the convention README in the packages folder + point CLAUDE.md at it

Browse Source 
Step 7 now writes <packages-root>/README.md next to the packages it
governs, and adds a context pointer from CLAUDE.md/AGENTS.md so an agent
discovers the boundary rule.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
Matt Pocock
2026-07-10 09:55:08 +01:00
co-authored by Claude Opus 4.8
parent d80ff7a840
commit f947f93b92
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
skills/in-progress/setup-deep-modules/SKILL.md
+4 -2
View File
@@ -83,9 +83,11 @@ This is the completion criterion for the whole skill — a config that doesn't f
### 7. Document the convention ### 7. Document the convention
Write a short `docs/deep-modules.md` (or append to the repo's contributing/README) covering: the `src/packages/<name>/` layout, "import only through `index.ts`", where tests live, and how to run `lint:boundaries`. Keep it to the copy-me snippet plus the four rules in one paragraph each. Write a `README.md` **in the packages folder** (`<packages-root>/README.md`) — next to the packages it governs — covering: the `src/packages/<name>/` layout, "import only through `index.ts`", where tests live, and how to run `lint:boundaries`. Keep it to the copy-me snippet plus the four rules in one paragraph each.
**Done when:** a contributor can read one page and know the layout and the boundary rule. Then add a **context pointer** to it from the repo's agent-instructions file — `CLAUDE.md` if present, else `AGENTS.md` (create `AGENTS.md` if neither exists). One line is enough, e.g. `Packages are deep modules — see [src/packages/README.md](./src/packages/README.md) before adding or importing one.` This is what makes an agent discover the boundary rule instead of tripping over it.
**Done when:** `<packages-root>/README.md` exists, and the repo's `CLAUDE.md`/`AGENTS.md` links to it.
## Notes ## Notes