mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-04-02 15:13:28 +08:00
feat: add everything-claude-code-conventions ECC bundle (.claude/skills/everything-claude-code/SKILL.md)
This commit is contained in:
ecc-tools[bot]
@@ -5,7 +5,7 @@ description: Development conventions and patterns for everything-claude-code. Ja
|
||||
|
||||
# Everything Claude Code Conventions
|
||||
|
||||
> Generated from [affaan-m/everything-claude-code](https://github.com/affaan-m/everything-claude-code) on 2026-03-20
|
||||
> Generated from [affaan-m/everything-claude-code](https://github.com/affaan-m/everything-claude-code) on 2026-04-02
|
||||
|
||||
## Overview
|
||||
|
||||
@@ -34,13 +34,13 @@ Follow these commit message conventions based on 500 analyzed commits.
|
||||
### Prefixes Used
|
||||
|
||||
- `fix`
|
||||
- `test`
|
||||
- `feat`
|
||||
- `docs`
|
||||
- `chore`
|
||||
|
||||
### Message Guidelines
|
||||
|
||||
- Average message length: ~65 characters
|
||||
- Average message length: ~56 characters
|
||||
- Keep first line concise and descriptive
|
||||
- Use imperative mood ("Add feature" not "Added feature")
|
||||
|
||||
@@ -48,49 +48,49 @@ Follow these commit message conventions based on 500 analyzed commits.
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat(rules): add C# language support
|
||||
feat(skills): add argus-design-review — three-tier design doc review
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
chore(deps-dev): bump flatted (#675)
|
||||
fix(tests): add USERPROFILE to repair.test.js for Windows
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix: auto-detect ECC root from plugin cache when CLAUDE_PLUGIN_ROOT is unset (#547) (#691)
|
||||
refactor: collapse legacy command bodies into skills
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
docs: add Antigravity setup and usage guide (#552)
|
||||
docs: close bundle drift and sync plugin guidance
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
merge: PR #529 — feat(skills): add documentation-lookup, bun-runtime, nextjs-turbopack; feat(agents): add rust-reviewer
|
||||
chore: ignore local orchestration artifacts
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
Revert "Add Kiro IDE support (.kiro/) (#548)"
|
||||
fix(lint): add missing trailing newlines to remotion rules
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
Add Kiro IDE support (.kiro/) (#548)
|
||||
fix(tests): normalize path separators in CLAUDE_PLUGIN_ROOT test
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add block-no-verify hook for Claude Code and Cursor (#649)
|
||||
fix(ci): resolve markdownlint errors and Windows install-apply test
|
||||
```
|
||||
|
||||
## Architecture
|
||||
@@ -184,33 +184,11 @@ try {
|
||||
|
||||
These workflows were detected from analyzing commit patterns.
|
||||
|
||||
### Database Migration
|
||||
|
||||
Database schema changes with migration files
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create migration file
|
||||
2. Update schema definitions
|
||||
3. Generate/update types
|
||||
|
||||
**Files typically involved**:
|
||||
- `**/schema.*`
|
||||
- `migrations/*`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
feat: implement --with/--without selective install flags (#679)
|
||||
fix: sync catalog counts with filesystem (27 agents, 113 skills, 58 commands) (#693)
|
||||
feat(rules): add Rust language rules (rebased #660) (#686)
|
||||
```
|
||||
|
||||
### Feature Development
|
||||
|
||||
Standard feature implementation workflow
|
||||
|
||||
**Frequency**: ~22 times per month
|
||||
**Frequency**: ~16 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add feature implementation
|
||||
@@ -218,205 +196,207 @@ Standard feature implementation workflow
|
||||
3. Update documentation
|
||||
|
||||
**Files typically involved**:
|
||||
- `manifests/*`
|
||||
- `schemas/*`
|
||||
- `.opencode/*`
|
||||
- `.opencode/plugins/*`
|
||||
- `.opencode/plugins/lib/*`
|
||||
- `**/*.test.*`
|
||||
- `**/api/**`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
feat(skills): add documentation-lookup, bun-runtime, nextjs-turbopack; feat(agents): add rust-reviewer
|
||||
docs(skills): align documentation-lookup with CONTRIBUTING template; add cross-harness (Codex/Cursor) skill copies
|
||||
fix: address PR review — skill template (When to use, How it works, Examples), bun.lock, next build note, rust-reviewer CI note, doc-lookup privacy/uncertainty
|
||||
feat(team-builder): use `claude agents` command for agent discovery (#1021)
|
||||
fix: extract inline SessionStart bootstrap to separate file (#1035)
|
||||
feat: add hexagonal architecture SKILL. (#1034)
|
||||
```
|
||||
|
||||
### Add Language Rules
|
||||
### Refactoring
|
||||
|
||||
Adds a new programming language to the rules system, including coding style, hooks, patterns, security, and testing guidelines.
|
||||
Code refactoring and cleanup workflow
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create a new directory under rules/{language}/
|
||||
2. Add coding-style.md, hooks.md, patterns.md, security.md, and testing.md files with language-specific content
|
||||
3. Optionally reference or link to related skills
|
||||
1. Ensure tests pass before refactor
|
||||
2. Refactor code structure
|
||||
3. Verify tests still pass
|
||||
|
||||
**Files typically involved**:
|
||||
- `rules/*/coding-style.md`
|
||||
- `rules/*/hooks.md`
|
||||
- `rules/*/patterns.md`
|
||||
- `rules/*/security.md`
|
||||
- `rules/*/testing.md`
|
||||
- `src/**/*`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create a new directory under rules/{language}/
|
||||
Add coding-style.md, hooks.md, patterns.md, security.md, and testing.md files with language-specific content
|
||||
Optionally reference or link to related skills
|
||||
refactor: collapse legacy command bodies into skills
|
||||
feat: add connected operator workflow skills
|
||||
feat: expand lead intelligence outreach channels
|
||||
```
|
||||
|
||||
### Add New Skill
|
||||
|
||||
Adds a new skill to the system, documenting its workflow, triggers, and usage, often with supporting scripts.
|
||||
Adds a new skill to the system, including documentation and registration in summary/index files.
|
||||
|
||||
**Frequency**: ~4 times per month
|
||||
**Frequency**: ~6 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create a new directory under skills/{skill-name}/
|
||||
2. Add SKILL.md with documentation (When to Use, How It Works, Examples, etc.)
|
||||
3. Optionally add scripts or supporting files under skills/{skill-name}/scripts/
|
||||
4. Address review feedback and iterate on documentation
|
||||
1. Create a new SKILL.md file under skills/{skill-name}/
|
||||
2. Optionally add reference files or assets under skills/{skill-name}/references/ or assets/
|
||||
3. Update AGENTS.md and README.md to document the new skill
|
||||
4. Update docs/zh-CN/AGENTS.md and docs/zh-CN/README.md for Chinese documentation
|
||||
5. Optionally update manifests/install-components.json or install-modules.json if the skill is installable
|
||||
|
||||
**Files typically involved**:
|
||||
- `skills/*/SKILL.md`
|
||||
- `skills/*/scripts/*.sh`
|
||||
- `skills/*/scripts/*.js`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create a new directory under skills/{skill-name}/
|
||||
Add SKILL.md with documentation (When to Use, How It Works, Examples, etc.)
|
||||
Optionally add scripts or supporting files under skills/{skill-name}/scripts/
|
||||
Address review feedback and iterate on documentation
|
||||
```
|
||||
|
||||
### Add New Agent
|
||||
|
||||
Adds a new agent to the system for code review, build resolution, or other automated tasks.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create a new agent markdown file under agents/{agent-name}.md
|
||||
2. Register the agent in AGENTS.md
|
||||
3. Optionally update README.md and docs/COMMAND-AGENT-MAP.md
|
||||
|
||||
**Files typically involved**:
|
||||
- `agents/*.md`
|
||||
- `skills/*/references/*.md`
|
||||
- `skills/*/assets/*`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `docs/COMMAND-AGENT-MAP.md`
|
||||
- `README.zh-CN.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
- `docs/zh-CN/README.md`
|
||||
- `manifests/install-components.json`
|
||||
- `manifests/install-modules.json`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create a new agent markdown file under agents/{agent-name}.md
|
||||
Register the agent in AGENTS.md
|
||||
Optionally update README.md and docs/COMMAND-AGENT-MAP.md
|
||||
Create a new SKILL.md file under skills/{skill-name}/
|
||||
Optionally add reference files or assets under skills/{skill-name}/references/ or assets/
|
||||
Update AGENTS.md and README.md to document the new skill
|
||||
Update docs/zh-CN/AGENTS.md and docs/zh-CN/README.md for Chinese documentation
|
||||
Optionally update manifests/install-components.json or install-modules.json if the skill is installable
|
||||
```
|
||||
|
||||
### Add New Command
|
||||
### Add Or Update Command Workflow
|
||||
|
||||
Adds a new command to the system, often paired with a backing skill.
|
||||
|
||||
**Frequency**: ~1 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create a new markdown file under commands/{command-name}.md
|
||||
2. Optionally add or update a backing skill under skills/{skill-name}/SKILL.md
|
||||
|
||||
**Files typically involved**:
|
||||
- `commands/*.md`
|
||||
- `skills/*/SKILL.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create a new markdown file under commands/{command-name}.md
|
||||
Optionally add or update a backing skill under skills/{skill-name}/SKILL.md
|
||||
```
|
||||
|
||||
### Sync Catalog Counts
|
||||
|
||||
Synchronizes the documented counts of agents, skills, and commands in AGENTS.md and README.md with the actual repository state.
|
||||
Adds or updates a command file describing a workflow, often for agent orchestration or developer automation.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Update agent, skill, and command counts in AGENTS.md
|
||||
2. Update the same counts in README.md (quick-start, comparison table, etc.)
|
||||
3. Optionally update other documentation files
|
||||
1. Create or modify a Markdown file under commands/ (e.g., commands/prp-*.md, commands/gan-*.md, commands/santa-loop.md)
|
||||
2. Document the workflow with YAML frontmatter, usage, and output sections
|
||||
3. Optionally update AGENTS.md, README.md, or other summary files if the command is significant
|
||||
4. Address review feedback and iterate on the command file
|
||||
|
||||
**Files typically involved**:
|
||||
- `commands/*.md`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Update agent, skill, and command counts in AGENTS.md
|
||||
Update the same counts in README.md (quick-start, comparison table, etc.)
|
||||
Optionally update other documentation files
|
||||
Create or modify a Markdown file under commands/ (e.g., commands/prp-*.md, commands/gan-*.md, commands/santa-loop.md)
|
||||
Document the workflow with YAML frontmatter, usage, and output sections
|
||||
Optionally update AGENTS.md, README.md, or other summary files if the command is significant
|
||||
Address review feedback and iterate on the command file
|
||||
```
|
||||
|
||||
### Add Cross Harness Skill Copies
|
||||
### Add Or Update Agent Definition
|
||||
|
||||
Adds skill copies for different agent harnesses (e.g., Codex, Cursor, Antigravity) to ensure compatibility across platforms.
|
||||
Adds or updates agent definition files to introduce or modify agent behaviors or roles.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Copy or adapt SKILL.md to .agents/skills/{skill}/SKILL.md and/or .cursor/skills/{skill}/SKILL.md
|
||||
2. Optionally add harness-specific openai.yaml or config files
|
||||
3. Address review feedback to align with CONTRIBUTING template
|
||||
1. Create or modify agent definition Markdown files under agents/
|
||||
2. Optionally update AGENTS.md to reflect new or changed agents
|
||||
3. Update skills or commands that reference the agent if necessary
|
||||
|
||||
**Files typically involved**:
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `.cursor/skills/*/SKILL.md`
|
||||
- `.agents/skills/*/agents/openai.yaml`
|
||||
- `agents/*.md`
|
||||
- `AGENTS.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Copy or adapt SKILL.md to .agents/skills/{skill}/SKILL.md and/or .cursor/skills/{skill}/SKILL.md
|
||||
Optionally add harness-specific openai.yaml or config files
|
||||
Address review feedback to align with CONTRIBUTING template
|
||||
Create or modify agent definition Markdown files under agents/
|
||||
Optionally update AGENTS.md to reflect new or changed agents
|
||||
Update skills or commands that reference the agent if necessary
|
||||
```
|
||||
|
||||
### Add Or Update Hook
|
||||
### Add Install Target Or Adapter
|
||||
|
||||
Adds or updates git or bash hooks to enforce workflow, quality, or security policies.
|
||||
Adds a new install target (integration with external tools/platforms) including schema, scripts, and tests.
|
||||
|
||||
**Frequency**: ~1 times per month
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add or update hook scripts in hooks/ or scripts/hooks/
|
||||
2. Register the hook in hooks/hooks.json or similar config
|
||||
3. Optionally add or update tests in tests/hooks/
|
||||
1. Create a new directory under .{target}/ with README and install/uninstall scripts
|
||||
2. Add or update scripts/lib/install-targets/{target}-project.js
|
||||
3. Update manifests/install-modules.json and schemas/ecc-install-config.schema.json
|
||||
4. Update registry.js and install-manifests.js as needed
|
||||
5. Add or update tests for the new install target
|
||||
|
||||
**Files typically involved**:
|
||||
- `hooks/*.hook`
|
||||
- `hooks/hooks.json`
|
||||
- `scripts/hooks/*.js`
|
||||
- `tests/hooks/*.test.js`
|
||||
- `.cursor/hooks.json`
|
||||
- `.*/README.md`
|
||||
- `.*/install.*`
|
||||
- `.*/uninstall.*`
|
||||
- `scripts/lib/install-targets/*.js`
|
||||
- `manifests/install-modules.json`
|
||||
- `schemas/ecc-install-config.schema.json`
|
||||
- `schemas/install-modules.schema.json`
|
||||
- `scripts/lib/install-manifests.js`
|
||||
- `scripts/lib/install-targets/registry.js`
|
||||
- `tests/lib/install-targets.test.js`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Add or update hook scripts in hooks/ or scripts/hooks/
|
||||
Register the hook in hooks/hooks.json or similar config
|
||||
Optionally add or update tests in tests/hooks/
|
||||
Create a new directory under .{target}/ with README and install/uninstall scripts
|
||||
Add or update scripts/lib/install-targets/{target}-project.js
|
||||
Update manifests/install-modules.json and schemas/ecc-install-config.schema.json
|
||||
Update registry.js and install-manifests.js as needed
|
||||
Add or update tests for the new install target
|
||||
```
|
||||
|
||||
### Address Review Feedback
|
||||
### Test Fix Or Portability Fix
|
||||
|
||||
Addresses code review feedback by updating documentation, scripts, or configuration for clarity, correctness, or convention alignment.
|
||||
Fixes or improves test scripts, especially for cross-platform (Windows/Linux) compatibility.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit test files under tests/scripts/ or tests/lib/
|
||||
2. Normalize environment variables or path separators for Windows compatibility
|
||||
3. Update related implementation files if needed (e.g., scripts/lib/install/apply.js)
|
||||
4. Commit with a fix(tests): or fix(ci): message
|
||||
|
||||
**Files typically involved**:
|
||||
- `tests/scripts/*.test.js`
|
||||
- `tests/lib/*.test.js`
|
||||
- `scripts/lib/install/*.js`
|
||||
- `scripts/lib/install-manifests.js`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit test files under tests/scripts/ or tests/lib/
|
||||
Normalize environment variables or path separators for Windows compatibility
|
||||
Update related implementation files if needed (e.g., scripts/lib/install/apply.js)
|
||||
Commit with a fix(tests): or fix(ci): message
|
||||
```
|
||||
|
||||
### Update Repo Documentation And Guidance
|
||||
|
||||
Updates documentation files to reflect new workflows, skills, or repo guidance.
|
||||
|
||||
**Frequency**: ~4 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit SKILL.md, agent, or command files to address reviewer comments
|
||||
2. Update examples, headings, or configuration as requested
|
||||
3. Iterate until all review feedback is resolved
|
||||
1. Edit README.md, README.zh-CN.md, WORKING-CONTEXT.md, AGENTS.md, or the-shortform-guide.md
|
||||
2. Edit docs/zh-CN/* as needed for Chinese documentation
|
||||
3. Optionally update .claude-plugin/README.md, .codex-plugin/README.md, or related plugin docs
|
||||
|
||||
**Files typically involved**:
|
||||
- `skills/*/SKILL.md`
|
||||
- `agents/*.md`
|
||||
- `commands/*.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `.cursor/skills/*/SKILL.md`
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `WORKING-CONTEXT.md`
|
||||
- `AGENTS.md`
|
||||
- `the-shortform-guide.md`
|
||||
- `docs/zh-CN/*.md`
|
||||
- `.claude-plugin/README.md`
|
||||
- `.codex-plugin/README.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit SKILL.md, agent, or command files to address reviewer comments
|
||||
Update examples, headings, or configuration as requested
|
||||
Iterate until all review feedback is resolved
|
||||
Edit README.md, README.zh-CN.md, WORKING-CONTEXT.md, AGENTS.md, or the-shortform-guide.md
|
||||
Edit docs/zh-CN/* as needed for Chinese documentation
|
||||
Optionally update .claude-plugin/README.md, .codex-plugin/README.md, or related plugin docs
|
||||
```
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user