Menu
Use when adding project conventions, coding rules, or guidelines. Determines correct location and scoping based on which packages the rule applies to.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
| name | creating-rules |
| description | Use when adding project conventions, coding rules, or guidelines. Determines correct location and scoping based on which packages the rule applies to. |
Determine correct location and scoping for new conventions/rules.
Does rule apply to ONE specific package?
├─ YES → packages/<name>/.claude/CONVENTIONS.md
│ (auto-loaded by package-conventions rule)
│
└─ NO → .claude/rules/<topic>.md
│
Does it apply to ALL packages?
├─ YES → paths: "packages/**/*"
│ (or omit paths for truly global)
│
└─ NO → Use YAML array:
paths:
- "packages/effect/**/*"
- "packages/vitest/**/*"
Location: packages/<name>/.claude/CONVENTIONS.md
# <Package> Package Conventions
Package-specific development conventions for `@kitz/<name>`.
## <Topic>
<content>
No frontmatter needed - auto-loaded by the package-conventions rule.
Location: .claude/rules/<topic>.md
---
paths:
- 'packages/effect/**/*'
- 'packages/vitest/**/*'
---
# <Topic>
<content>
Important: Always quote glob patterns (YAML reserves * and {).
| Pattern | Matches |
|---|---|
"packages/**/*" | All packages |
"packages/effect/**/*" | Single package |
"**/*.ts" | All TypeScript files |
"!**/*.test.ts" | Exclude test files |
Rule for effect package only:
→ packages/effect/.claude/CONVENTIONS.md
Rule for packages using Effect services:
→ .claude/rules/effect-services.md with paths array listing those packages
Rule for all code:
→ .claude/rules/<topic>.md with paths: "packages/**/*" or no paths
Rules are auto-loaded into context. To save tokens, put research links and detailed rationale in a separate .refs.md file:
.claude/rules/
├── my-rule.md ← Auto-loaded (keep concise)
└── my-rule.refs.md ← NOT auto-loaded (link to it)
In the rule, add:
## References
See [my-rule.refs.md](./my-rule.refs.md)
The refs file can contain:
Add a namespace/module to a @kitz package — including extending the @kitz/effect namespaces. Covers the _.ts/__.ts barrel pattern, the package exports map, and import conventions.
Audits the project for consistency issues that may arise from manual editing. Checks package scripts, tsconfig paths, README tables, and other conventions.
Authors and manages global package scripts using the _: prefix convention. Scripts defined in root package.json are propagated to all packages with the prefix stripped.
Creates commits following project conventions. Handles Conventional Commits with project-specific scopes, PR title requirements, and CI validation rules.
Create a new @kitz/<concept> package via the Vite+ generator. Scaffolds package.json (live-types exports + effect peer), the layered tsconfigs, and the namespace barrel, then wires it into the workspace.
Use when filing a GitHub issue for this repo — a bug found during QA/stress-testing, or a feature/enhancement request. Enforces the two permitted cold-startable formats (bug = Expected/Actual, feature = Current/Desired), point-form-only bodies, and the gh filing procedure. Trigger on "file an issue", "open a bug", "log this finding", "make a gh issue", or after stress-testing surfaces a defect.