chore: scaffold ai-coding-skills repository structure
This commit is contained in:
31
docs/repository-structure.md
Normal file
31
docs/repository-structure.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Repository Structure
|
||||
|
||||
This repository follows a superpowers-style organization for long-term maintainability.
|
||||
|
||||
## Top-level directories
|
||||
|
||||
- `skills/` → All installable skills.
|
||||
- `docs/` → Repository-level guidance.
|
||||
- `.codex/` → Codex-specific integration/config notes.
|
||||
- `.claude-plugin/` → Claude Code plugin metadata/integration notes.
|
||||
- `.opencode/plugins/` → OpenCode plugin metadata/integration notes.
|
||||
- `commands/` → Optional command wrappers.
|
||||
- `hooks/` → Optional pre/post hooks.
|
||||
- `tests/` → Regression tests for triggering/behavior.
|
||||
|
||||
## Skill Folder Contract
|
||||
|
||||
Each skill folder should contain at minimum:
|
||||
|
||||
- `SKILL.md` (required)
|
||||
|
||||
Optional:
|
||||
|
||||
- `scripts/` (deterministic execution)
|
||||
- `references/` (detailed docs)
|
||||
- `assets/` (templates/resources)
|
||||
|
||||
## Naming
|
||||
|
||||
- lowercase + hyphen only
|
||||
- one skill per folder
|
||||
Reference in New Issue
Block a user