docs(skills): add agent skills for simple_module_python - #62
Merged
Conversation
Add six standalone agent skills under skills/ (Anthropic Agent Skills format) so AI agents working in any simple_module_python project — host or module package — get the framework's invariants and workflows loaded into context on demand. Publishable to skills.sh via `npx skills add antosubash/simple_module_python`. Skills: - simple-module-creating — scaffolding, entry-point, ModuleMeta - simple-module-conventions — SQLModel-everywhere, settings layout, framework→plugin direction, Zod-in-hooks, etc. - simple-module-database — per-module Base, mixins, get_db lifecycle - simple-module-migrations — host-owned migrations, branch_labels - simple-module-inertia-pages — render keys, shared props, SM003/4/18 - simple-module-doctor — full SM001–SM018 reference The skills don't reference paths internal to this dev repo (modules/, docs/, scripts/, packages/ui/, make targets), so they install cleanly into user-land projects and reflect the canonical `sm` CLI (create-module, host gen-pages) rather than this repo's Makefile.
Cover the full sm CLI surface: sm new (the wizard for greenfield apps), sm create-host, sm create-module, sm host gen-pages, sm host sync-js-deps, sm settings import-from-env, and sm users create-admin. Includes preset/--with semantics (catalog keys for sm new, PascalCase ModuleMeta names for sm create-host) and the per-flag option tables.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds six standalone agent skills under
skills/(Anthropic Agent Skills format) so AI agents — Claude Code, Cursor, Codex, Windsurf, OpenCode, etc. — working in anysimple_module_pythonproject get the framework's invariants and workflows loaded into context on demand.Publishable to skills.sh via:
What's in the directory
simple-module-creatingModuleMeta, post-scaffold stepssimple-module-conventionssimple-module-databaseBase, mixins,get_dblifecycle, no-session.commit()-in-servicessimple-module-migrationsbranch_labelson first revision, autogenerate covering installed modulessimple-module-inertia-pagesauth.userprincipal_serializerrequirement), SM003/SM004/SM018simple-module-doctorDesign
modules/,docs/,scripts/,packages/ui/,maketargets). They install cleanly into a host project scaffolded withsm create-hostor a module package scaffolded withsm create-module.sm create-module,sm host gen-pages, anduv run alembic …directly rather than this repo's Makefile shortcuts.descriptionfields are "use when…" trigger phrases only — no workflow summaries. Per writing-skills guidance, summarized descriptions cause agents to follow the description in lieu of reading the body.Verifying claims
Spot-checked against the codebase before landing:
app.state.<module_lower>(no_settingssuffix) — confirmed inmodules/users/,modules/file_storage/,modules/background_tasks/. The diagnostics check accepts either lowercase package name ormeta.name.lower().sm host gen-pages— confirmed as the canonical CLI form (plugin subcommand under thehostgroup).ModuleMetafields, mixin behavior, render-key mapping, branch-label requirement — verified againstframework/core/,framework/db/,framework/hosting/.Publishing
After merge, the skills are reachable at
github.com/antosubash/simple_module_python/tree/main/skillsand discoverable vianpx skills add antosubash/simple_module_python. To seed the leaderboard telemetry, run that command once locally.Test plan
npx skills add antosubash/simple_module_python --listlists all six.npx skills add antosubash/simple_module_python --skill simple-module-creating -a claude-code— verify.claude/skills/simple-module-creating/SKILL.mdappears.SKILL.md— confirm nomake/scripts//modules/products//docs/references to repo-internal paths.npx skills add antosubash/simple_module_python --skill '*' -a claude-codeinstalls all six.