AGENTS
Repository Guidance This repository stores portable custom Codex skills, backups of custom local plugins, and the docs/scripts that maintain b...
Repository Guidance This repository stores portable custom Codex skills, backups of custom local plugins, and the docs/scripts that maintain both. ## Operating assumptions - Treat skills/ as the primary product.
Repository Guidance
This repository stores portable custom Codex skills, backups of custom local plugins, and the docs/scripts that maintain both.
Operating assumptions
- Treat
skills/as the primary product. - Treat
skills/SUITE_SKILLS.txtas the source of truth for which skills belong in this repo. - Treat
skills/SUITE_METADATA.jsonas the source of truth for lifecycle labeling such asexperimental,legacy,deprecated, andarchived. - Treat
plugins/as a backup area for custom plugins only, not a mirrored catalog of every installed plugin. - Keep the repository lean; avoid project-management scaffolding that is meant for delivery repos.
- Treat
docs-site/as the public marketing, catalog, and implementation docs surface, not as repo maintenance documentation. - Preserve portability. A skill copied out of this repo should still work as a standalone skill.
- Prefer repo-wide conventions over one-off formatting changes.
Required workflow
When adding or updating skills:
- keep each skill folder self-contained
- preserve existing bundled licenses or notices found inside imported skills
- do not remove provenance-sensitive files unless explicitly asked
- update
skills/SUITE_SKILLS.txtwhen adding or removing a suite skill - update
skills/SUITE_METADATA.jsonwhen a skill's lifecycle status changes - run
python3 scripts/build_catalog.py --checkto catch drift before regeneration - regenerate
skills/manifest.jsonandskills/INDEX.mdwithpython3 scripts/build_catalog.py - regenerate
docs-site/src/lib/catalog.generated.tswithpython3 scripts/build_docs_site_catalog.pywhen public skill docs should reflect the change - update top-level docs when the repo structure or contribution process changes materially
When adding or updating custom plugin backups:
- keep each plugin folder self-contained under
plugins/ - preserve
.codex-plugin/plugin.jsonand any plugin-specific assets/scripts - update
.agents/plugins/marketplace.jsonso the repo backup remains installable as a repo-local plugin set - update top-level docs when the plugin backup structure changes materially
- regenerate
docs-site/src/lib/catalog.generated.tswithpython3 scripts/build_docs_site_catalog.pywhen public plugin docs should reflect the change
Scope boundaries
- Do not add a public open-source license unless the user explicitly requests one.
- Do not import hidden/system skills such as
.system/unless explicitly requested. - Do not mirror every installed local skill into this repo; only track allowlisted suite skills.
- Do not mirror every installed local plugin into this repo; only back up custom local plugins.
- Do not silently rewrite imported skills just to normalize tone or structure; preserve intent unless there is a clear repo-wide reason to refactor.
Quality bar
- Skill metadata must stay trigger-oriented and accurate.
- Experimental, deprecated, legacy, and archived skills must be visibly labeled in repo-level metadata and generated catalog output.
- Public-facing docs should be clear enough for future external sharing.
- Scripts should use the standard library when practical and avoid unnecessary dependencies.
Repo Notes And Evidence
- Use
DOCS/as the lean repo-native notes and evidence root. - Use
DOCS/PROJECTS/for numbered project memory and lifecycle tracking. - Use
DOCS/evidence/for durable evidence, review artifacts, and audit packets. - Use
docs-site/only for public marketing, catalog, setup, implementation, and troubleshooting docs. - Lifecycle transitions:
active -> in-reviewwhen implementation is complete and awaiting walkthrough/sign-off;* -> blockedwhen progress requires user decision, permission, input, or access;in-review -> completedonly after collaborative walkthrough/sign-off. - Continue autonomous execution from backlog/stale while items are in
in-revieworblocked. - Use literal
MAGGIE TODO:callouts for Maggie-owned or externally gated manual follow-up items. - Generate docs timestamps with
node scripts/docs/timestamp-et.mjs --json; do not hand-type relativetoday/tomorrowstatus notes.
Provenance
- Source file:
AGENTS.md - Source URL: https://github.com/maggielerman/codex-skills/blob/main/AGENTS.md