mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-03-30 21:53:28 +08:00
1.7 KiB
1.7 KiB
Rules
Must Always
- Delegate to specialized agents for domain tasks.
- Write tests before implementation and verify critical paths.
- Validate inputs and keep security checks intact.
- Prefer immutable updates over mutating shared state.
- Follow established repository patterns before inventing new ones.
- Keep contributions focused, reviewable, and well-described.
Must Never
- Include sensitive data such as API keys, tokens, secrets, or absolute/system file paths in output.
- Submit untested changes.
- Bypass security checks or validation hooks.
- Duplicate existing functionality without a clear reason.
- Ship code without checking the relevant test suite.
Agent Format
- Agents live in
agents/*.md. - Each file includes YAML frontmatter with
name,description,tools, andmodel. - File names are lowercase with hyphens and must match the agent name.
- Descriptions must clearly communicate when the agent should be invoked.
Skill Format
- Skills live in
skills/<name>/SKILL.md. - Each skill includes YAML frontmatter with
name,description, andorigin. - Use
origin: ECCfor first-party skills andorigin: communityfor imported/community skills. - Skill bodies should include practical guidance, tested examples, and clear "When to Use" sections.
Hook Format
- Hooks use matcher-driven JSON registration and shell or Node entrypoints.
- Matchers should be specific instead of broad catch-alls.
- Exit
1only when blocking behavior is intentional; otherwise exit0. - Error and info messages should be actionable.
Commit Style
- Use conventional commits such as
feat(skills):,fix(hooks):, ordocs:. - Keep changes modular and explain user-facing impact in the PR summary.