From 8bfd40862271a2340b0d795a3fb3c90a5d1a5254 Mon Sep 17 00:00:00 2001 From: "ecc-tools[bot]" <257055122+ecc-tools[bot]@users.noreply.github.com> Date: Wed, 1 Apr 2026 22:58:12 +0000 Subject: [PATCH] feat: add everything-claude-code ECC bundle (.agents/skills/everything-claude-code/SKILL.md) --- .../skills/everything-claude-code/SKILL.md | 580 +++++------------- 1 file changed, 152 insertions(+), 428 deletions(-) diff --git a/.agents/skills/everything-claude-code/SKILL.md b/.agents/skills/everything-claude-code/SKILL.md index 173826a8..e65fcc6f 100644 --- a/.agents/skills/everything-claude-code/SKILL.md +++ b/.agents/skills/everything-claude-code/SKILL.md @@ -1,442 +1,166 @@ ---- -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 common workflows for contributing to the `everything-claude-code` repository. The project is JavaScript-based, with no framework dependencies, and emphasizes modularity, agentic skills, and workflow automation. This guide covers file organization, commit conventions, code style, workflow steps, and testing patterns to help you contribute effectively and consistently. -## Tech Stack +## Coding Conventions -- **Primary Language**: JavaScript -- **Architecture**: hybrid module organization -- **Test Location**: separate +- **File Naming:** Use camelCase for JavaScript files and folders. + - Example: `mySkill.js`, `installTarget.js` +- **Import Style:** Use relative imports. + - Example: + ```js + const helper = require('./utils/helper'); + ``` +- **Export Style:** Mixed (both CommonJS and ES module styles may be present). + - Example (CommonJS): + ```js + module.exports = function mySkill() { ... }; + ``` + - Example (ESM): + ```js + export default function mySkill() { ... } + ``` +- **Commit Messages:** Follow [Conventional Commits](https://www.conventionalcommits.org/) with prefixes such as `fix`, `feat`, `docs`, `chore`. + - Example: `feat: add support for new install target` +- **Test Files:** Use the pattern `*.test.js` for test files. -## When to Use This Skill +## Workflows -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 +### Add or Update a Skill +**Trigger:** When introducing or updating a workflow, agent, or capability +**Command:** `/add-skill` -## Commit Conventions +1. Create or update a `SKILL.md` file in one of: + - `skills//SKILL.md` + - `.agents/skills//SKILL.md` + - `.claude/skills//SKILL.md` +2. Optionally update `AGENTS.md`, `README.md`, or `manifests/install-modules.json` to reference the new skill. +3. Document the skill's usage and integration points. -Follow these commit message conventions based on 500 analyzed commits. - -### Commit Style: Conventional Commits - -### Prefixes Used - -- `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:** +```bash +/add-skill ``` -*Commit message example* - -```text -chore(deps-dev): bump flatted (#675) -``` - -*Commit message example* - -```text -fix: auto-detect ECC root from plugin cache when CLAUDE_PLUGIN_ROOT is unset (#547) (#691) -``` - -*Commit message example* - -```text -docs: add Antigravity setup and usage guide (#552) -``` - -*Commit message example* - -```text -merge: PR #529 — feat(skills): add documentation-lookup, bun-runtime, nextjs-turbopack; feat(agents): add rust-reviewer -``` - -*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') -} -``` - -## Common Workflows - -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 - -**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 Workflow Surface - -Adds or updates a workflow entrypoint. Default to skills-first; only add a command shim when legacy slash compatibility is still required. - -**Frequency**: ~1 times per month - -**Steps**: -1. Create or update the canonical workflow under skills/{skill-name}/SKILL.md -2. Only if needed, add or update commands/{command-name}.md as a compatibility shim - -**Files typically involved**: -- `skills/*/SKILL.md` -- `commands/*.md` (only when a legacy shim is intentionally retained) - -**Example commit sequence**: -``` -Create or update the canonical skill under skills/{skill-name}/SKILL.md -Only if needed, add or update commands/{command-name}.md as a compatibility shim -``` - -### 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.* +### Add or Update a Command +**Trigger:** When adding a new CLI command, workflow, or extending command capabilities +**Command:** `/add-command` + +1. Create or update a markdown file in `commands/` (e.g., `commands/.md`). +2. Optionally update related documentation (`README.md`, `AGENTS.md`). +3. If the command is part of a workflow, update or create associated artifacts or scripts. + +**Example:** +```bash +/add-command +``` + +--- + +### Add or Update an Agent +**Trigger:** When introducing a new agent or updating agent logic +**Command:** `/add-agent` + +1. Create or update agent definition markdown in `agents/.md` or `.opencode/prompts/agents/.txt`. +2. Register or update the agent in `opencode.json` or related config. +3. Update `AGENTS.md` with new agent details. + +**Example:** +```bash +/add-agent +``` + +--- + +### Add or Update an Install Target +**Trigger:** When supporting a new platform/tool for installation/integration +**Command:** `/add-install-target` + +1. Create or update install scripts (`.sh`/`.js`) and documentation in a dot-directory (e.g., `.codebuddy/`, `.gemini/`). +2. Update `manifests/install-modules.json` and `schemas/ecc-install-config.schema.json`. +3. Update `scripts/lib/install-manifests.js` and `scripts/lib/install-targets/.js`. +4. Add or update tests for install targets. + +**Example:** +```bash +/add-install-target +``` + +--- + +### Add or Update CI Workflow +**Trigger:** When updating CI workflows, adding new checks, or bumping dependencies +**Command:** `/update-ci` + +1. Edit or add files in `.github/workflows/`. +2. Update `package.json` or `yarn.lock` if dependency-related. +3. Test CI to ensure the new workflow or dependency works as intended. + +**Example:** +```bash +/update-ci +``` + +--- + +### Update Hooks or Validation Scripts +**Trigger:** When improving or fixing pre/post hooks, or validation logic for edits and CI +**Command:** `/update-hooks` + +1. Edit `hooks/hooks.json` and supporting scripts in `scripts/hooks/`. +2. Update or add tests in `tests/hooks/` or `tests/scripts/`. +3. Optionally update related documentation. + +**Example:** +```bash +/update-hooks +``` + +--- + +### Add or Update Documentation +**Trigger:** When documenting new workflows, updating guides, or adding troubleshooting info +**Command:** `/update-docs` + +1. Edit or add markdown files in `docs/`, `WORKING-CONTEXT.md`, or `the-shortform-guide.md`. +2. Update `README.md` and/or `README.zh-CN.md`. +3. Optionally update related skill or agent docs. + +**Example:** +```bash +/update-docs +``` + +## Testing Patterns + +- **Test Files:** Place tests in the same directory as the code or in a `tests/` directory, using the `*.test.js` naming convention. +- **Framework:** No specific testing framework detected; use standard JavaScript test runners (e.g., Jest, Mocha) as appropriate. +- **Example Test File:** + ```js + // mySkill.test.js + const mySkill = require('./mySkill'); + + test('should return expected result', () => { + expect(mySkill('input')).toBe('expected output'); + }); + ``` + +## Commands + +| Command | Purpose | +|---------------------|--------------------------------------------------------------| +| /add-skill | Add or update a skill (workflow, agent, or capability) | +| /add-command | Add or update a command file for new or extended workflows | +| /add-agent | Add or update an agent definition | +| /add-install-target | Add or update an install target for external integrations | +| /update-ci | Add or update CI/CD workflow files or dependencies | +| /update-hooks | Update hooks or validation scripts | +| /update-docs | Add or update documentation | +```