mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-04-02 15:13:28 +08:00
Compare commits
15 Commits
ecc-tools/
...
ecc-tools/
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6855d312f9 | ||
|
|
a38bbda48d | ||
|
|
e79b18d92a | ||
|
|
a11f1bcf19 | ||
|
|
22da7d3255 | ||
|
|
7c43826e05 | ||
|
|
6bb9c2bb75 | ||
|
|
d166ca2a7a | ||
|
|
d8ea7b8f9a | ||
|
|
141251f446 | ||
|
|
8fd89187ee | ||
|
|
7cc68b4bdf | ||
|
|
d7a1397df7 | ||
|
|
c3a0485b57 | ||
|
|
d9987eecb7 |
@@ -1,165 +1,422 @@
|
||||
```markdown
|
||||
# everything-claude-code Development Patterns
|
||||
---
|
||||
name: everything-claude-code-conventions
|
||||
description: Development conventions and patterns for everything-claude-code. JavaScript project with conventional commits.
|
||||
---
|
||||
|
||||
> Auto-generated skill from repository analysis
|
||||
# Everything Claude Code Conventions
|
||||
|
||||
> Generated from [affaan-m/everything-claude-code](https://github.com/affaan-m/everything-claude-code) on 2026-04-02
|
||||
|
||||
## Overview
|
||||
|
||||
This skill teaches the core development patterns, coding conventions, and collaborative workflows used in the `everything-claude-code` JavaScript repository. The project is modular, skill-oriented, and emphasizes clear documentation, conventional commits, and extensibility via skills, agents, commands, and install targets. This guide will help you contribute effectively by following established patterns and using the right commands for common tasks.
|
||||
This skill teaches Claude the development patterns and conventions used in everything-claude-code.
|
||||
|
||||
## Coding Conventions
|
||||
## Tech Stack
|
||||
|
||||
**File Naming**
|
||||
- Use `camelCase` for JavaScript files and directories.
|
||||
- Example: `mySkill.js`, `installTarget.js`
|
||||
- **Primary Language**: JavaScript
|
||||
- **Architecture**: hybrid module organization
|
||||
- **Test Location**: separate
|
||||
|
||||
**Import Style**
|
||||
- Use relative imports.
|
||||
- Example:
|
||||
```js
|
||||
const helper = require('./helper');
|
||||
import { doSomething } from '../utils/doSomething';
|
||||
```
|
||||
## When to Use This Skill
|
||||
|
||||
**Export Style**
|
||||
- Mixed: both CommonJS (`module.exports`) and ES6 (`export`) exports are used.
|
||||
- Example (CommonJS):
|
||||
```js
|
||||
module.exports = function myFunction() { ... };
|
||||
```
|
||||
- Example (ES6):
|
||||
```js
|
||||
export function myFunction() { ... }
|
||||
```
|
||||
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
|
||||
|
||||
**Commit Messages**
|
||||
- Use [Conventional Commits](https://www.conventionalcommits.org/):
|
||||
- Prefixes: `fix`, `feat`, `docs`, `chore`
|
||||
- Example: `feat: add new agent pipeline for document processing`
|
||||
## Commit Conventions
|
||||
|
||||
## Workflows
|
||||
Follow these commit message conventions based on 500 analyzed commits.
|
||||
|
||||
### Commit Style: Conventional Commits
|
||||
|
||||
### Prefixes Used
|
||||
|
||||
- `fix`
|
||||
- `feat`
|
||||
- `docs`
|
||||
- `chore`
|
||||
|
||||
### Message Guidelines
|
||||
|
||||
- Average message length: ~56 characters
|
||||
- Keep first line concise and descriptive
|
||||
- Use imperative mood ("Add feature" not "Added feature")
|
||||
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat(skills): add argus-design-review — three-tier design doc review
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix(tests): add USERPROFILE to repair.test.js for Windows
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
refactor: collapse legacy command bodies into skills
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
docs: close bundle drift and sync plugin guidance
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
chore: ignore local orchestration artifacts
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix(lint): add missing trailing newlines to remotion rules
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix(tests): normalize path separators in CLAUDE_PLUGIN_ROOT test
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix(ci): resolve markdownlint errors and Windows install-apply test
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
||||
### Feature Development
|
||||
|
||||
Standard feature implementation workflow
|
||||
|
||||
**Frequency**: ~16 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add feature implementation
|
||||
2. Add tests for feature
|
||||
3. Update documentation
|
||||
|
||||
**Files typically involved**:
|
||||
- `.opencode/*`
|
||||
- `.opencode/plugins/*`
|
||||
- `.opencode/plugins/lib/*`
|
||||
- `**/*.test.*`
|
||||
- `**/api/**`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
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)
|
||||
```
|
||||
|
||||
### Refactoring
|
||||
|
||||
Code refactoring and cleanup workflow
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Ensure tests pass before refactor
|
||||
2. Refactor code structure
|
||||
3. Verify tests still pass
|
||||
|
||||
**Files typically involved**:
|
||||
- `src/**/*`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
refactor: collapse legacy command bodies into skills
|
||||
feat: add connected operator workflow skills
|
||||
feat: expand lead intelligence outreach channels
|
||||
```
|
||||
|
||||
### Add New Skill
|
||||
**Trigger:** When introducing a new skill (capability/module) to the platform
|
||||
**Command:** `/add-skill`
|
||||
|
||||
1. Create a new `SKILL.md` under `skills/<skill-name>/` or `.agents/skills/<skill-name>/`.
|
||||
2. Optionally add related assets or references in the skill directory.
|
||||
3. Update documentation:
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
4. If the skill is installable, update:
|
||||
- `manifests/install-components.json` or
|
||||
- `manifests/install-modules.json`
|
||||
5. Optionally update `WORKING-CONTEXT.md`.
|
||||
Adds a new skill to the system, including documentation and registration in summary/index files.
|
||||
|
||||
**Example directory structure:**
|
||||
**Frequency**: ~6 times per month
|
||||
|
||||
**Steps**:
|
||||
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/*/references/*.md`
|
||||
- `skills/*/assets/*`
|
||||
- `AGENTS.md`
|
||||
- `README.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**:
|
||||
```
|
||||
skills/
|
||||
myNewSkill/
|
||||
SKILL.md
|
||||
index.js
|
||||
assets/
|
||||
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 Or Update Command Workflow
|
||||
|
||||
### Add New Agent or Pipeline
|
||||
**Trigger:** When introducing a new agent or orchestrated workflow (pipeline)
|
||||
**Command:** `/add-agent-pipeline`
|
||||
Adds or updates a command file describing a workflow, often for agent orchestration or developer automation.
|
||||
|
||||
1. Create agent definition files under `agents/`.
|
||||
2. Create or update a `SKILL.md` for the orchestrator under `skills/<pipeline-name>/`.
|
||||
3. Update `AGENTS.md` and `README.md` to document the new agent(s)/pipeline.
|
||||
4. Optionally add supporting commands, scripts, or documentation.
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
---
|
||||
**Steps**:
|
||||
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
|
||||
|
||||
### Add or Extend Command
|
||||
**Trigger:** When adding or enhancing CLI commands
|
||||
**Command:** `/add-command`
|
||||
**Files typically involved**:
|
||||
- `commands/*.md`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
|
||||
1. Create or update command markdown files under `commands/`.
|
||||
2. Incorporate review feedback and fixes as needed.
|
||||
3. Document new commands in `AGENTS.md` or other relevant docs.
|
||||
|
||||
---
|
||||
|
||||
### Add Install Target or Adapter
|
||||
**Trigger:** When supporting a new install target (plugin, IDE, platform)
|
||||
**Command:** `/add-install-target`
|
||||
|
||||
1. Create a new directory for the install target (e.g., `.codebuddy/`, `.gemini/`).
|
||||
2. Add install/uninstall scripts and documentation in the new directory.
|
||||
3. Update `manifests/install-modules.json` and relevant schemas.
|
||||
4. Update or add scripts in `scripts/lib/install-targets/<target>.js`.
|
||||
5. Update or add tests for the new install target.
|
||||
|
||||
**Example:**
|
||||
**Example commit sequence**:
|
||||
```
|
||||
.codebuddy/
|
||||
install.sh
|
||||
uninstall.sh
|
||||
README.md
|
||||
scripts/lib/install-targets/codebuddy.js
|
||||
tests/lib/install-targets.test.js
|
||||
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 Or Update Agent Definition
|
||||
|
||||
### Update or Harden Hooks
|
||||
**Trigger:** When improving, refactoring, or fixing hooks (e.g., CI, formatting, session management)
|
||||
**Command:** `/update-hook`
|
||||
Adds or updates agent definition files to introduce or modify agent behaviors or roles.
|
||||
|
||||
1. Update `hooks/hooks.json` to change hook configuration.
|
||||
2. Update or add scripts in `scripts/hooks/*.js` or `scripts/hooks/*.sh`.
|
||||
3. Update or add tests for the affected hooks.
|
||||
4. Optionally update related documentation.
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
---
|
||||
**Steps**:
|
||||
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
|
||||
|
||||
### Documentation Sync and Guidance Update
|
||||
**Trigger:** When updating documentation to reflect new features, skills, or workflows
|
||||
**Command:** `/sync-docs`
|
||||
**Files typically involved**:
|
||||
- `agents/*.md`
|
||||
- `AGENTS.md`
|
||||
|
||||
1. Update `README.md`, `README.zh-CN.md`, and/or `AGENTS.md`.
|
||||
2. Update `docs/zh-CN/AGENTS.md` and `docs/zh-CN/README.md`.
|
||||
3. Update or add `WORKING-CONTEXT.md`.
|
||||
4. Optionally update `the-shortform-guide.md` or other guidance files.
|
||||
|
||||
---
|
||||
|
||||
### Dependency Bump via Dependabot
|
||||
**Trigger:** When a dependency update is triggered by Dependabot or similar automation
|
||||
**Command:** `/bump-dependency`
|
||||
|
||||
1. Update `package.json` and/or `yarn.lock` for npm dependencies.
|
||||
2. Update `.github/workflows/*.yml` for GitHub Actions dependencies.
|
||||
3. Commit with a standardized message and co-author.
|
||||
|
||||
---
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
- Test files use the pattern `*.test.js`.
|
||||
- Testing framework is not explicitly specified; check test files for usage.
|
||||
- Place tests alongside or within a `tests/` directory, matching the structure of the code under test.
|
||||
- Example test file:
|
||||
```
|
||||
tests/lib/install-targets.test.js
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Purpose |
|
||||
|--------------------|------------------------------------------------------------------|
|
||||
| /add-skill | Add a new skill, including docs and registration |
|
||||
| /add-agent-pipeline| Add a new agent or orchestrated pipeline |
|
||||
| /add-command | Add or extend a CLI command |
|
||||
| /add-install-target| Add support for a new install target or adapter |
|
||||
| /update-hook | Refactor or fix hooks and related scripts |
|
||||
| /sync-docs | Synchronize and update documentation across contexts/languages |
|
||||
| /bump-dependency | Automated dependency update via Dependabot or similar automation |
|
||||
**Example commit sequence**:
|
||||
```
|
||||
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 Install Target Or Adapter
|
||||
|
||||
Adds a new install target (integration with external tools/platforms) including schema, scripts, and tests.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
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**:
|
||||
- `.*/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**:
|
||||
```
|
||||
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
|
||||
```
|
||||
|
||||
### Test Fix Or Portability Fix
|
||||
|
||||
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 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**:
|
||||
- `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 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
|
||||
```
|
||||
|
||||
|
||||
## 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.*
|
||||
|
||||
@@ -10,16 +10,16 @@ Use this workflow when working on **add-new-skill** in `everything-claude-code`.
|
||||
|
||||
## Goal
|
||||
|
||||
Adds a new skill to the system, including documentation and registration in relevant indexes.
|
||||
Adds a new skill to the system, including documentation and registration in summary/index files.
|
||||
|
||||
## Common Files
|
||||
|
||||
- `skills/*/SKILL.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `skills/*/references/*.md`
|
||||
- `skills/*/assets/*`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
|
||||
## Suggested Sequence
|
||||
|
||||
@@ -30,11 +30,11 @@ Adds a new skill to the system, including documentation and registration in rele
|
||||
|
||||
## Typical Commit Signals
|
||||
|
||||
- Create a new SKILL.md file under skills/<skill-name>/ or .agents/skills/<skill-name>/
|
||||
- Optionally add related assets or references under the skill directory
|
||||
- Update AGENTS.md, README.md, README.zh-CN.md, and docs/zh-CN/AGENTS.md to document the new skill
|
||||
- Update manifests/install-components.json or manifests/install-modules.json if the skill is installable
|
||||
- Optionally update WORKING-CONTEXT.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
|
||||
|
||||
## Notes
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
"version": "1.3",
|
||||
"schemaVersion": "1.0",
|
||||
"generatedBy": "ecc-tools",
|
||||
"generatedAt": "2026-04-02T03:20:48.238Z",
|
||||
"generatedAt": "2026-04-02T03:25:20.900Z",
|
||||
"repo": "https://github.com/affaan-m/everything-claude-code",
|
||||
"profiles": {
|
||||
"requested": "full",
|
||||
|
||||
@@ -10,5 +10,5 @@
|
||||
"javascript"
|
||||
],
|
||||
"suggestedBy": "ecc-tools-repo-analysis",
|
||||
"createdAt": "2026-04-02T03:21:37.492Z"
|
||||
"createdAt": "2026-04-02T03:26:02.848Z"
|
||||
}
|
||||
@@ -18,4 +18,4 @@ Use this when the task is documentation-heavy, source-sensitive, or requires bro
|
||||
|
||||
- Primary language: JavaScript
|
||||
- Framework: Not detected
|
||||
- Workflows detected: 9
|
||||
- Workflows detected: 8
|
||||
@@ -26,7 +26,7 @@ Generated by ECC Tools from repository history. Review before treating it as a h
|
||||
|
||||
- feature-development: Standard feature implementation workflow
|
||||
- refactoring: Code refactoring and cleanup workflow
|
||||
- add-new-skill: Adds a new skill to the system, including documentation and registration in relevant indexes.
|
||||
- add-new-skill: Adds a new skill to the system, including documentation and registration in summary/index files.
|
||||
|
||||
## Review Reminder
|
||||
|
||||
|
||||
@@ -1,165 +1,422 @@
|
||||
```markdown
|
||||
# everything-claude-code Development Patterns
|
||||
---
|
||||
name: everything-claude-code-conventions
|
||||
description: Development conventions and patterns for everything-claude-code. JavaScript project with conventional commits.
|
||||
---
|
||||
|
||||
> Auto-generated skill from repository analysis
|
||||
# Everything Claude Code Conventions
|
||||
|
||||
> Generated from [affaan-m/everything-claude-code](https://github.com/affaan-m/everything-claude-code) on 2026-04-02
|
||||
|
||||
## Overview
|
||||
|
||||
This skill teaches the core development patterns, coding conventions, and collaborative workflows used in the `everything-claude-code` JavaScript repository. The project is modular, skill-oriented, and emphasizes clear documentation, conventional commits, and extensibility via skills, agents, commands, and install targets. This guide will help you contribute effectively by following established patterns and using the right commands for common tasks.
|
||||
This skill teaches Claude the development patterns and conventions used in everything-claude-code.
|
||||
|
||||
## Coding Conventions
|
||||
## Tech Stack
|
||||
|
||||
**File Naming**
|
||||
- Use `camelCase` for JavaScript files and directories.
|
||||
- Example: `mySkill.js`, `installTarget.js`
|
||||
- **Primary Language**: JavaScript
|
||||
- **Architecture**: hybrid module organization
|
||||
- **Test Location**: separate
|
||||
|
||||
**Import Style**
|
||||
- Use relative imports.
|
||||
- Example:
|
||||
```js
|
||||
const helper = require('./helper');
|
||||
import { doSomething } from '../utils/doSomething';
|
||||
```
|
||||
## When to Use This Skill
|
||||
|
||||
**Export Style**
|
||||
- Mixed: both CommonJS (`module.exports`) and ES6 (`export`) exports are used.
|
||||
- Example (CommonJS):
|
||||
```js
|
||||
module.exports = function myFunction() { ... };
|
||||
```
|
||||
- Example (ES6):
|
||||
```js
|
||||
export function myFunction() { ... }
|
||||
```
|
||||
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
|
||||
|
||||
**Commit Messages**
|
||||
- Use [Conventional Commits](https://www.conventionalcommits.org/):
|
||||
- Prefixes: `fix`, `feat`, `docs`, `chore`
|
||||
- Example: `feat: add new agent pipeline for document processing`
|
||||
## Commit Conventions
|
||||
|
||||
## Workflows
|
||||
Follow these commit message conventions based on 500 analyzed commits.
|
||||
|
||||
### Commit Style: Conventional Commits
|
||||
|
||||
### Prefixes Used
|
||||
|
||||
- `fix`
|
||||
- `feat`
|
||||
- `docs`
|
||||
- `chore`
|
||||
|
||||
### Message Guidelines
|
||||
|
||||
- Average message length: ~56 characters
|
||||
- Keep first line concise and descriptive
|
||||
- Use imperative mood ("Add feature" not "Added feature")
|
||||
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat(skills): add argus-design-review — three-tier design doc review
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix(tests): add USERPROFILE to repair.test.js for Windows
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
refactor: collapse legacy command bodies into skills
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
docs: close bundle drift and sync plugin guidance
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
chore: ignore local orchestration artifacts
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix(lint): add missing trailing newlines to remotion rules
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix(tests): normalize path separators in CLAUDE_PLUGIN_ROOT test
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix(ci): resolve markdownlint errors and Windows install-apply test
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
||||
### Feature Development
|
||||
|
||||
Standard feature implementation workflow
|
||||
|
||||
**Frequency**: ~16 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add feature implementation
|
||||
2. Add tests for feature
|
||||
3. Update documentation
|
||||
|
||||
**Files typically involved**:
|
||||
- `.opencode/*`
|
||||
- `.opencode/plugins/*`
|
||||
- `.opencode/plugins/lib/*`
|
||||
- `**/*.test.*`
|
||||
- `**/api/**`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
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)
|
||||
```
|
||||
|
||||
### Refactoring
|
||||
|
||||
Code refactoring and cleanup workflow
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Ensure tests pass before refactor
|
||||
2. Refactor code structure
|
||||
3. Verify tests still pass
|
||||
|
||||
**Files typically involved**:
|
||||
- `src/**/*`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
refactor: collapse legacy command bodies into skills
|
||||
feat: add connected operator workflow skills
|
||||
feat: expand lead intelligence outreach channels
|
||||
```
|
||||
|
||||
### Add New Skill
|
||||
**Trigger:** When introducing a new skill (capability/module) to the platform
|
||||
**Command:** `/add-skill`
|
||||
|
||||
1. Create a new `SKILL.md` under `skills/<skill-name>/` or `.agents/skills/<skill-name>/`.
|
||||
2. Optionally add related assets or references in the skill directory.
|
||||
3. Update documentation:
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
4. If the skill is installable, update:
|
||||
- `manifests/install-components.json` or
|
||||
- `manifests/install-modules.json`
|
||||
5. Optionally update `WORKING-CONTEXT.md`.
|
||||
Adds a new skill to the system, including documentation and registration in summary/index files.
|
||||
|
||||
**Example directory structure:**
|
||||
**Frequency**: ~6 times per month
|
||||
|
||||
**Steps**:
|
||||
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/*/references/*.md`
|
||||
- `skills/*/assets/*`
|
||||
- `AGENTS.md`
|
||||
- `README.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**:
|
||||
```
|
||||
skills/
|
||||
myNewSkill/
|
||||
SKILL.md
|
||||
index.js
|
||||
assets/
|
||||
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 Or Update Command Workflow
|
||||
|
||||
### Add New Agent or Pipeline
|
||||
**Trigger:** When introducing a new agent or orchestrated workflow (pipeline)
|
||||
**Command:** `/add-agent-pipeline`
|
||||
Adds or updates a command file describing a workflow, often for agent orchestration or developer automation.
|
||||
|
||||
1. Create agent definition files under `agents/`.
|
||||
2. Create or update a `SKILL.md` for the orchestrator under `skills/<pipeline-name>/`.
|
||||
3. Update `AGENTS.md` and `README.md` to document the new agent(s)/pipeline.
|
||||
4. Optionally add supporting commands, scripts, or documentation.
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
---
|
||||
**Steps**:
|
||||
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
|
||||
|
||||
### Add or Extend Command
|
||||
**Trigger:** When adding or enhancing CLI commands
|
||||
**Command:** `/add-command`
|
||||
**Files typically involved**:
|
||||
- `commands/*.md`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
|
||||
1. Create or update command markdown files under `commands/`.
|
||||
2. Incorporate review feedback and fixes as needed.
|
||||
3. Document new commands in `AGENTS.md` or other relevant docs.
|
||||
|
||||
---
|
||||
|
||||
### Add Install Target or Adapter
|
||||
**Trigger:** When supporting a new install target (plugin, IDE, platform)
|
||||
**Command:** `/add-install-target`
|
||||
|
||||
1. Create a new directory for the install target (e.g., `.codebuddy/`, `.gemini/`).
|
||||
2. Add install/uninstall scripts and documentation in the new directory.
|
||||
3. Update `manifests/install-modules.json` and relevant schemas.
|
||||
4. Update or add scripts in `scripts/lib/install-targets/<target>.js`.
|
||||
5. Update or add tests for the new install target.
|
||||
|
||||
**Example:**
|
||||
**Example commit sequence**:
|
||||
```
|
||||
.codebuddy/
|
||||
install.sh
|
||||
uninstall.sh
|
||||
README.md
|
||||
scripts/lib/install-targets/codebuddy.js
|
||||
tests/lib/install-targets.test.js
|
||||
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 Or Update Agent Definition
|
||||
|
||||
### Update or Harden Hooks
|
||||
**Trigger:** When improving, refactoring, or fixing hooks (e.g., CI, formatting, session management)
|
||||
**Command:** `/update-hook`
|
||||
Adds or updates agent definition files to introduce or modify agent behaviors or roles.
|
||||
|
||||
1. Update `hooks/hooks.json` to change hook configuration.
|
||||
2. Update or add scripts in `scripts/hooks/*.js` or `scripts/hooks/*.sh`.
|
||||
3. Update or add tests for the affected hooks.
|
||||
4. Optionally update related documentation.
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
---
|
||||
**Steps**:
|
||||
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
|
||||
|
||||
### Documentation Sync and Guidance Update
|
||||
**Trigger:** When updating documentation to reflect new features, skills, or workflows
|
||||
**Command:** `/sync-docs`
|
||||
**Files typically involved**:
|
||||
- `agents/*.md`
|
||||
- `AGENTS.md`
|
||||
|
||||
1. Update `README.md`, `README.zh-CN.md`, and/or `AGENTS.md`.
|
||||
2. Update `docs/zh-CN/AGENTS.md` and `docs/zh-CN/README.md`.
|
||||
3. Update or add `WORKING-CONTEXT.md`.
|
||||
4. Optionally update `the-shortform-guide.md` or other guidance files.
|
||||
|
||||
---
|
||||
|
||||
### Dependency Bump via Dependabot
|
||||
**Trigger:** When a dependency update is triggered by Dependabot or similar automation
|
||||
**Command:** `/bump-dependency`
|
||||
|
||||
1. Update `package.json` and/or `yarn.lock` for npm dependencies.
|
||||
2. Update `.github/workflows/*.yml` for GitHub Actions dependencies.
|
||||
3. Commit with a standardized message and co-author.
|
||||
|
||||
---
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
- Test files use the pattern `*.test.js`.
|
||||
- Testing framework is not explicitly specified; check test files for usage.
|
||||
- Place tests alongside or within a `tests/` directory, matching the structure of the code under test.
|
||||
- Example test file:
|
||||
```
|
||||
tests/lib/install-targets.test.js
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Purpose |
|
||||
|--------------------|------------------------------------------------------------------|
|
||||
| /add-skill | Add a new skill, including docs and registration |
|
||||
| /add-agent-pipeline| Add a new agent or orchestrated pipeline |
|
||||
| /add-command | Add or extend a CLI command |
|
||||
| /add-install-target| Add support for a new install target or adapter |
|
||||
| /update-hook | Refactor or fix hooks and related scripts |
|
||||
| /sync-docs | Synchronize and update documentation across contexts/languages |
|
||||
| /bump-dependency | Automated dependency update via Dependabot or similar automation |
|
||||
**Example commit sequence**:
|
||||
```
|
||||
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 Install Target Or Adapter
|
||||
|
||||
Adds a new install target (integration with external tools/platforms) including schema, scripts, and tests.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
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**:
|
||||
- `.*/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**:
|
||||
```
|
||||
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
|
||||
```
|
||||
|
||||
### Test Fix Or Portability Fix
|
||||
|
||||
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 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**:
|
||||
- `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 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
|
||||
```
|
||||
|
||||
|
||||
## 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.*
|
||||
|
||||
@@ -11,5 +11,5 @@
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-new-skill.md"
|
||||
],
|
||||
"updatedAt": "2026-04-02T03:20:48.238Z"
|
||||
"updatedAt": "2026-04-02T03:25:20.900Z"
|
||||
}
|
||||
Reference in New Issue
Block a user