From f642cb0e315c86e390985c21efebf1c38bfeadc1 Mon Sep 17 00:00:00 2001 From: "ecc-tools[bot]" <257055122+ecc-tools[bot]@users.noreply.github.com> Date: Thu, 2 Apr 2026 03:27:10 +0000 Subject: [PATCH] feat: add everything-claude-code ECC bundle (.claude/skills/everything-claude-code/SKILL.md) --- .../skills/everything-claude-code/SKILL.md | 542 +++++------------- 1 file changed, 137 insertions(+), 405 deletions(-) diff --git a/.claude/skills/everything-claude-code/SKILL.md b/.claude/skills/everything-claude-code/SKILL.md index 799c37f5..7f3e9af2 100644 --- a/.claude/skills/everything-claude-code/SKILL.md +++ b/.claude/skills/everything-claude-code/SKILL.md @@ -1,442 +1,174 @@ ---- -name: everything-claude-code-conventions -description: Development conventions and patterns for everything-claude-code. JavaScript project with conventional commits. ---- +```markdown +# everything-claude-code Development Patterns -# Everything Claude Code Conventions - -> Generated from [affaan-m/everything-claude-code](https://github.com/affaan-m/everything-claude-code) on 2026-03-20 +> Auto-generated skill from repository analysis ## Overview -This skill teaches Claude the development patterns and conventions used in everything-claude-code. +This skill introduces the core development patterns, coding conventions, and collaborative workflows used in the `everything-claude-code` repository. The project is a JavaScript codebase (no framework detected) focused on modular skills, agent orchestration, automation workflows, and extensible install targets. It emphasizes clear documentation, conventional commits, and a structured approach to adding new capabilities. -## Tech Stack +## Coding Conventions -- **Primary Language**: JavaScript -- **Architecture**: hybrid module organization -- **Test Location**: separate +- **File Naming:** + Use `camelCase` for JavaScript files and directories. + _Example:_ + ``` + installTargetProject.js + agentPipeline.md + ``` -## When to Use This Skill +- **Import Style:** + Use **relative imports** for modules within the codebase. + _Example:_ + ```js + const installTarget = require('../lib/install-targets/codeBuddy-project.js'); + ``` -Activate this skill when: -- Making changes to this repository -- Adding new features following established patterns -- Writing tests that match project conventions -- Creating commits with proper message format +- **Export Style:** + Mixed usage of CommonJS (`module.exports`) and ES module (`export`) patterns, depending on context. + _Example (CommonJS):_ + ```js + module.exports = function installTarget() { ... }; + ``` + _Example (ESM):_ + ```js + export function installTarget() { ... } + ``` -## Commit Conventions +- **Commit Messages:** + Use [Conventional Commits](https://www.conventionalcommits.org/) with prefixes: `fix`, `feat`, `docs`, `chore`. + _Example:_ + ``` + feat: add support for new agent pipeline + fix: correct install script path resolution + ``` -Follow these commit message conventions based on 500 analyzed commits. +## Workflows -### Commit Style: Conventional Commits +### Add New Skill +**Trigger:** When you want to add a new skill (capability, agent, or workflow) +**Command:** `/add-skill` -### Prefixes Used +1. Create a new `SKILL.md` file under `skills//` or `.agents/skills//`. +2. Optionally add related reference files (schemas, assets) in the skill directory. +3. Update documentation files to reference the new skill: + - `AGENTS.md` + - `README.md` + - `README.zh-CN.md` + - `docs/zh-CN/AGENTS.md` +4. Optionally update install manifests (e.g., `manifests/install-components.json`) if the skill is installable. -- `fix` -- `test` -- `feat` -- `docs` - -### Message Guidelines - -- Average message length: ~65 characters -- Keep first line concise and descriptive -- Use imperative mood ("Add feature" not "Added feature") - - -*Commit message example* - -```text -feat(rules): add C# language support +_Example directory structure:_ +``` +skills/myNewSkill/SKILL.md +skills/myNewSkill/schema.json ``` -*Commit message example* +### Add New Command or Workflow +**Trigger:** When introducing a new command-line workflow or process +**Command:** `/add-command` -```text -chore(deps-dev): bump flatted (#675) +1. Create a new markdown file under `commands/` (e.g., `commands/myWorkflow.md`). +2. Document the workflow with YAML frontmatter, usage, and output sections. +3. Update `AGENTS.md`, `README.md`, or other summary files to reference the new command. +4. Optionally update scripts or examples if automation is included. + +_Example:_ +```markdown +--- +name: santa-loop +description: Automates the Santa workflow +--- +# santa-loop +Usage: ... ``` -*Commit message example* +### Add New Agent or Agent Pipeline +**Trigger:** When adding a new agent or multi-agent pipeline +**Command:** `/add-agent-pipeline` -```text -fix: auto-detect ECC root from plugin cache when CLAUDE_PLUGIN_ROOT is unset (#547) (#691) +1. Create agent definition markdown files under `agents/` (e.g., `agents/myAgent.md`). +2. Optionally, create a new orchestrator skill under `skills//SKILL.md`. +3. Update `AGENTS.md` and `README.md` to reference the new agent(s) or pipeline. +4. Optionally add example or configuration files. + +_Example:_ +``` +agents/opensource-pipeline.md +skills/opensource-pipeline/SKILL.md ``` -*Commit message example* +### Add or Update Install Target +**Trigger:** When supporting a new install target (IDE, platform) or updating install logic +**Command:** `/add-install-target` -```text -docs: add Antigravity setup and usage guide (#552) +1. Add or update install scripts and documentation under `./`. +2. Update `manifests/install-modules.json` and related schemas. +3. Add or update scripts in `scripts/lib/install-targets/-project.js`. +4. Update registry and test files as needed. +5. Update `README.md` or other summary docs. + +_Example:_ +``` +.codeBuddy/install.sh +scripts/lib/install-targets/codeBuddy-project.js ``` -*Commit message example* +### Update or Add Hooks and Automation +**Trigger:** When modifying or extending hooks and automation scripts +**Command:** `/update-hooks` -```text -merge: PR #529 — feat(skills): add documentation-lookup, bun-runtime, nextjs-turbopack; feat(agents): add rust-reviewer -``` +1. Edit `hooks/hooks.json` to add or update hook definitions. +2. Modify or create scripts in `scripts/hooks/*.js` for hook logic. +3. Update or add related test files under `tests/hooks/`. +4. Optionally update `.cursor/hooks/` or other adapter-specific files. -*Commit message example* - -```text -Revert "Add Kiro IDE support (.kiro/) (#548)" -``` - -*Commit message example* - -```text -Add Kiro IDE support (.kiro/) (#548) -``` - -*Commit message example* - -```text -feat: add block-no-verify hook for Claude Code and Cursor (#649) -``` - -## Architecture - -### Project Structure: Single Package - -This project uses **hybrid** module organization. - -### Configuration Files - -- `.github/workflows/ci.yml` -- `.github/workflows/maintenance.yml` -- `.github/workflows/monthly-metrics.yml` -- `.github/workflows/release.yml` -- `.github/workflows/reusable-release.yml` -- `.github/workflows/reusable-test.yml` -- `.github/workflows/reusable-validate.yml` -- `.opencode/package.json` -- `.opencode/tsconfig.json` -- `.prettierrc` -- `eslint.config.js` -- `package.json` - -### Guidelines - -- This project uses a hybrid organization -- Follow existing patterns when adding new code - -## Code Style - -### Language: JavaScript - -### Naming Conventions - -| Element | Convention | -|---------|------------| -| Files | camelCase | -| Functions | camelCase | -| Classes | PascalCase | -| Constants | SCREAMING_SNAKE_CASE | - -### Import Style: Relative Imports - -### Export Style: Mixed Style - - -*Preferred import style* - -```typescript -// Use relative imports -import { Button } from '../components/Button' -import { useAuth } from './hooks/useAuth' -``` - -## Testing - -### Test Framework - -No specific test framework detected — use the repository's existing test patterns. - -### File Pattern: `*.test.js` - -### Test Types - -- **Unit tests**: Test individual functions and components in isolation -- **Integration tests**: Test interactions between multiple components/services - -### Coverage - -This project has coverage reporting configured. Aim for 80%+ coverage. - - -## Error Handling - -### Error Handling Style: Try-Catch Blocks - - -*Standard error handling pattern* - -```typescript -try { - const result = await riskyOperation() - return result -} catch (error) { - console.error('Operation failed:', error) - throw new Error('User-friendly message') +_Example:_ +```json +// hooks/hooks.json +{ + "pre-commit": "node scripts/hooks/format.js" } ``` -## Common Workflows +### Documentation and Guidance Update +**Trigger:** When updating documentation or adding new guidance +**Command:** `/update-docs` -These workflows were detected from analyzing commit patterns. +1. Edit or create markdown files in the repo root or `docs/` directories. +2. Update `WORKING-CONTEXT.md` to reflect current practices. +3. Update or add `README.md`, `README.zh-CN.md`, and `AGENTS.md`. +4. Optionally update `.claude-plugin/` or `.codex-plugin/` README files. -### Database Migration +### Test or CI Fix +**Trigger:** When fixing or improving tests and CI integration +**Command:** `/fix-test` -Database schema changes with migration files +1. Edit test files under `tests/`. +2. Optionally edit scripts or hooks related to the test. +3. Update CI workflow files under `.github/workflows/` if needed. -**Frequency**: ~2 times per month +## Testing Patterns -**Steps**: -1. Create migration file -2. Update schema definitions -3. Generate/update types +- **Test Framework:** Not explicitly specified; test files follow the `*.test.js` pattern. +- **Test File Location:** Place test files under `tests/`, mirroring the structure of the code they test. +- **Example:** + ``` + tests/lib/install-targets.test.js + tests/hooks/format.test.js + ``` +- **Running Tests:** + Ensure your tests are named with `.test.js` and can be run via your preferred test runner (e.g., `node`, `jest`, etc.). -**Files typically involved**: -- `**/schema.*` -- `migrations/*` +## Commands -**Example commit sequence**: +| Command | Purpose | +|--------------------|--------------------------------------------------------------| +| /add-skill | Add a new skill (capability, agent, or workflow) | +| /add-command | Add a new command or workflow | +| /add-agent-pipeline| Add a new agent or multi-agent pipeline | +| /add-install-target| Add or update an install target (IDE, platform, plugin host) | +| /update-hooks | Update or add hooks and automation scripts | +| /update-docs | Update documentation and guidance | +| /fix-test | Fix or improve tests and CI integration | ``` -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 - -**Steps**: -1. Add feature implementation -2. Add tests for feature -3. Update documentation - -**Files typically involved**: -- `manifests/*` -- `schemas/*` -- `**/*.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 -``` - -### Add Language Rules - -Adds a new programming language to the rules system, including coding style, hooks, patterns, security, and testing guidelines. - -**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 - -**Files typically involved**: -- `rules/*/coding-style.md` -- `rules/*/hooks.md` -- `rules/*/patterns.md` -- `rules/*/security.md` -- `rules/*/testing.md` - -**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 -``` - -### Add New Skill - -Adds a new skill to the system, documenting its workflow, triggers, and usage, often with supporting scripts. - -**Frequency**: ~4 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 - -**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` -- `AGENTS.md` -- `README.md` -- `docs/COMMAND-AGENT-MAP.md` - -**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 -``` - -### Add New Command - -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. - -**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 - -**Files typically involved**: -- `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 -``` - -### Add Cross Harness Skill Copies - -Adds skill copies for different agent harnesses (e.g., Codex, Cursor, Antigravity) to ensure compatibility across platforms. - -**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 - -**Files typically involved**: -- `.agents/skills/*/SKILL.md` -- `.cursor/skills/*/SKILL.md` -- `.agents/skills/*/agents/openai.yaml` - -**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 -``` - -### Add Or Update Hook - -Adds or updates git or bash hooks to enforce workflow, quality, or security policies. - -**Frequency**: ~1 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/ - -**Files typically involved**: -- `hooks/*.hook` -- `hooks/hooks.json` -- `scripts/hooks/*.js` -- `tests/hooks/*.test.js` -- `.cursor/hooks.json` - -**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/ -``` - -### Address Review Feedback - -Addresses code review feedback by updating documentation, scripts, or configuration for clarity, correctness, or convention alignment. - -**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 - -**Files typically involved**: -- `skills/*/SKILL.md` -- `agents/*.md` -- `commands/*.md` -- `.agents/skills/*/SKILL.md` -- `.cursor/skills/*/SKILL.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 -``` - - -## Best Practices - -Based on analysis of the codebase, follow these practices: - -### Do - -- Use conventional commit format (feat:, fix:, etc.) -- Follow *.test.js naming pattern -- Use camelCase for file names -- Prefer mixed exports - -### Don't - -- Don't write vague commit messages -- Don't skip tests for new features -- Don't deviate from established patterns without discussion - ---- - -*This skill was auto-generated by [ECC Tools](https://ecc.tools). Review and customize as needed for your team.*