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 | |
|---|---|---|---|
|
abc8765eb7 | ||
|
|
18aa035073 | ||
|
|
a34e41d966 | ||
|
|
7fec0e6d96 | ||
|
|
ad6470cc42 | ||
|
|
e39c4017d1 | ||
|
|
72ee05fa41 | ||
|
|
48c16aa9f8 | ||
|
|
525ae748e0 | ||
|
|
2afae8059f | ||
|
|
657b9d9622 | ||
|
|
5e0d66a04c | ||
|
|
9a35ab9a56 | ||
|
|
2f7f82ffe9 | ||
|
|
e76ff48345 |
@@ -5,184 +5,161 @@
|
||||
|
||||
## Overview
|
||||
|
||||
This skill introduces the core development patterns, coding conventions, and collaborative workflows used in the `everything-claude-code` JavaScript repository. It covers how to add new skills or agents, update commands, manage install targets, maintain tests, update documentation, automate hooks, and handle dependency updates. Following these patterns ensures consistency, maintainability, and ease of collaboration across the codebase.
|
||||
|
||||
---
|
||||
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.
|
||||
|
||||
## Coding Conventions
|
||||
|
||||
**File Naming**
|
||||
- Use `camelCase` for JavaScript files and folders.
|
||||
- Example: `installManifests.js`, `voiceProfileSchema.md`
|
||||
- Use `camelCase` for JavaScript files and directories.
|
||||
- Example: `mySkill.js`, `installTarget.js`
|
||||
|
||||
**Import Style**
|
||||
- Use relative imports.
|
||||
- Example:
|
||||
```js
|
||||
const installManifests = require('./installManifests');
|
||||
const helper = require('./helper');
|
||||
import { doSomething } from '../utils/doSomething';
|
||||
```
|
||||
|
||||
**Export Style**
|
||||
- Mixed: Both CommonJS (`module.exports`) and ES6 (`export`) styles are present.
|
||||
- Mixed: both CommonJS (`module.exports`) and ES6 (`export`) exports are used.
|
||||
- Example (CommonJS):
|
||||
```js
|
||||
module.exports = function doSomething() { ... };
|
||||
module.exports = function myFunction() { ... };
|
||||
```
|
||||
- Example (ES6):
|
||||
```js
|
||||
export function doSomething() { ... }
|
||||
export function myFunction() { ... }
|
||||
```
|
||||
|
||||
**Commit Messages**
|
||||
- Use [Conventional Commits](https://www.conventionalcommits.org/).
|
||||
- Prefixes: `fix`, `feat`, `docs`, `chore`
|
||||
- Example:
|
||||
```
|
||||
feat: add voice profile schema reference for new agent
|
||||
```
|
||||
|
||||
---
|
||||
- Use [Conventional Commits](https://www.conventionalcommits.org/):
|
||||
- Prefixes: `fix`, `feat`, `docs`, `chore`
|
||||
- Example: `feat: add new agent pipeline for document processing`
|
||||
|
||||
## Workflows
|
||||
|
||||
### Add New Skill or Agent
|
||||
**Trigger:** When introducing a new skill or agent to the system
|
||||
### Add New Skill
|
||||
**Trigger:** When introducing a new skill (capability/module) to the platform
|
||||
**Command:** `/add-skill`
|
||||
|
||||
1. Create or update `SKILL.md` in `skills/<skill-name>/` or `.agents/skills/<skill-name>/`.
|
||||
2. Add or update documentation files (`README.md`, `AGENTS.md`, `docs/zh-CN/AGENTS.md`, etc.).
|
||||
3. Register the new skill/agent in `manifests/install-components.json` or `manifests/install-modules.json`.
|
||||
4. Optionally, add reference files or assets (e.g., `references/voice-profile-schema.md`, `assets/`).
|
||||
5. If adding an agent, create `agents/<agent-name>.md`.
|
||||
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`.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
# Add a new skill called "voiceProfile"
|
||||
mkdir -p skills/voiceProfile
|
||||
touch skills/voiceProfile/SKILL.md
|
||||
# Edit manifests/install-components.json to register
|
||||
**Example directory structure:**
|
||||
```
|
||||
skills/
|
||||
myNewSkill/
|
||||
SKILL.md
|
||||
index.js
|
||||
assets/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update Command Workflow
|
||||
**Trigger:** When adding or improving a CLI command
|
||||
### Add New Agent or Pipeline
|
||||
**Trigger:** When introducing a new agent or orchestrated workflow (pipeline)
|
||||
**Command:** `/add-agent-pipeline`
|
||||
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
### Add or Extend Command
|
||||
**Trigger:** When adding or enhancing CLI commands
|
||||
**Command:** `/add-command`
|
||||
|
||||
1. Create or update `commands/<command-name>.md` with YAML frontmatter, usage, and implementation details.
|
||||
2. Update related documentation (`README.md`, `AGENTS.md`).
|
||||
3. Update or add corresponding skill or agent documentation if relevant.
|
||||
|
||||
**Example:**
|
||||
```markdown
|
||||
# commands/review.md
|
||||
|
||||
---
|
||||
name: review
|
||||
description: Run code review workflow
|
||||
---
|
||||
|
||||
## Usage
|
||||
...
|
||||
```
|
||||
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 IDE, tool, or platform for installation
|
||||
**Trigger:** When supporting a new install target (plugin, IDE, platform)
|
||||
**Command:** `/add-install-target`
|
||||
|
||||
1. Create install scripts and documentation in a new folder (e.g., `.codebuddy/`, `.gemini/`).
|
||||
2. Add or update install-manifests and registry scripts (`scripts/lib/install-manifests.js`, `scripts/lib/install-targets/*.js`).
|
||||
3. Update schemas (`schemas/ecc-install-config.schema.json`, `schemas/install-modules.schema.json`).
|
||||
4. Register the new target in `manifests/install-modules.json`.
|
||||
5. Add or update tests for install targets.
|
||||
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:**
|
||||
```js
|
||||
// scripts/lib/install-targets/codebuddy.js
|
||||
module.exports = function installCodebuddy() { ... };
|
||||
```
|
||||
.codebuddy/
|
||||
install.sh
|
||||
uninstall.sh
|
||||
README.md
|
||||
scripts/lib/install-targets/codebuddy.js
|
||||
tests/lib/install-targets.test.js
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Update or Fix Tests
|
||||
**Trigger:** When fixing or updating tests for compatibility or new features
|
||||
**Command:** `/fix-test`
|
||||
|
||||
1. Edit test files in `tests/scripts/` or `tests/lib/` to address issues (e.g., path normalization, environment variables).
|
||||
2. Update implementation files if needed to support the test fix.
|
||||
3. Document the fix in the commit message.
|
||||
|
||||
**Example:**
|
||||
```js
|
||||
// tests/lib/install-targets.test.js
|
||||
test('should normalize Windows paths', () => {
|
||||
...
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Documentation and Guidance Update
|
||||
**Trigger:** When improving or updating documentation for users or contributors
|
||||
**Command:** `/update-docs`
|
||||
|
||||
1. Edit or add files like `README.md`, `WORKING-CONTEXT.md`, `AGENTS.md`, `the-shortform-guide.md`, and `docs/zh-CN/*`.
|
||||
2. Synchronize documentation across English and Chinese versions.
|
||||
3. Update or add troubleshooting guides and best practices.
|
||||
|
||||
---
|
||||
|
||||
### Update Hooks or Automation Scripts
|
||||
**Trigger:** When improving repo hooks or automation scripts
|
||||
### Update or Harden Hooks
|
||||
**Trigger:** When improving, refactoring, or fixing hooks (e.g., CI, formatting, session management)
|
||||
**Command:** `/update-hook`
|
||||
|
||||
1. Edit `hooks/hooks.json` to add or update hook definitions.
|
||||
2. Update or add scripts in `scripts/hooks/` or `scripts/lib/`.
|
||||
3. Update or add tests for hooks in `tests/hooks/`.
|
||||
4. Document changes in commit messages.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
### Dependency Update via Dependabot
|
||||
**Trigger:** When dependencies are bumped by dependabot or maintainers
|
||||
**Command:** `/bump-dep`
|
||||
### Documentation Sync and Guidance Update
|
||||
**Trigger:** When updating documentation to reflect new features, skills, or workflows
|
||||
**Command:** `/sync-docs`
|
||||
|
||||
1. Update dependency version in `package.json` or workflow YAML.
|
||||
2. Update lockfile (`yarn.lock` or `package-lock.json`).
|
||||
3. Commit with standardized message (`chore(deps): ...`).
|
||||
4. Update related workflow files if needed (`.github/workflows/*.yml`).
|
||||
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` and are located in `tests/scripts/` and `tests/lib/`.
|
||||
- Testing framework is not explicitly specified; use standard Node.js test runners (e.g., Jest, Mocha).
|
||||
- Tests focus on platform compatibility, feature coverage, and regression prevention.
|
||||
|
||||
**Example:**
|
||||
```js
|
||||
// tests/scripts/installScript.test.js
|
||||
describe('installScript', () => {
|
||||
it('should handle environment variables', () => {
|
||||
...
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
- 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 or agent, including docs and registration |
|
||||
| /add-command | Add or update a CLI command and its documentation |
|
||||
| /add-install-target | Add a new install target or adapter for integration |
|
||||
| /fix-test | Fix or update test files for compatibility or new features |
|
||||
| /update-docs | Update documentation and guidance files |
|
||||
| /update-hook | Update hooks or automation scripts |
|
||||
| /bump-dep | Bump dependency versions via dependabot or manually |
|
||||
| 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 |
|
||||
```
|
||||
|
||||
@@ -1,16 +1,16 @@
|
||||
---
|
||||
name: add-new-skill-or-agent
|
||||
description: Workflow command scaffold for add-new-skill-or-agent in everything-claude-code.
|
||||
name: add-new-skill
|
||||
description: Workflow command scaffold for add-new-skill in everything-claude-code.
|
||||
allowed_tools: ["Bash", "Read", "Write", "Grep", "Glob"]
|
||||
---
|
||||
|
||||
# /add-new-skill-or-agent
|
||||
# /add-new-skill
|
||||
|
||||
Use this workflow when working on **add-new-skill-or-agent** in `everything-claude-code`.
|
||||
Use this workflow when working on **add-new-skill** in `everything-claude-code`.
|
||||
|
||||
## Goal
|
||||
|
||||
Adds a new skill or agent to the codebase, including documentation and registration in manifests and index files.
|
||||
Adds a new skill to the system, including documentation and registration in relevant indexes.
|
||||
|
||||
## Common Files
|
||||
|
||||
@@ -30,11 +30,11 @@ Adds a new skill or agent to the codebase, including documentation and registrat
|
||||
|
||||
## Typical Commit Signals
|
||||
|
||||
- Create or update SKILL.md in skills/<skill-name>/ or .agents/skills/<skill-name>/
|
||||
- Add or update documentation files (README.md, AGENTS.md, docs/zh-CN/AGENTS.md, etc.)
|
||||
- Update manifests/install-components.json or manifests/install-modules.json to register the new skill/agent
|
||||
- Optionally add reference files or assets (e.g., references/voice-profile-schema.md, assets/)
|
||||
- If agent, add agents/<agent-name>.md
|
||||
- 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
|
||||
|
||||
## Notes
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
"version": "1.3",
|
||||
"schemaVersion": "1.0",
|
||||
"generatedBy": "ecc-tools",
|
||||
"generatedAt": "2026-04-02T03:26:28.561Z",
|
||||
"generatedAt": "2026-04-02T03:20:48.238Z",
|
||||
"repo": "https://github.com/affaan-m/everything-claude-code",
|
||||
"profiles": {
|
||||
"requested": "full",
|
||||
@@ -150,7 +150,7 @@
|
||||
".claude/enterprise/controls.md",
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-new-skill-or-agent.md"
|
||||
".claude/commands/add-new-skill.md"
|
||||
],
|
||||
"packageFiles": {
|
||||
"runtime-core": [
|
||||
@@ -180,7 +180,7 @@
|
||||
"workflow-pack": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-new-skill-or-agent.md"
|
||||
".claude/commands/add-new-skill.md"
|
||||
]
|
||||
},
|
||||
"moduleFiles": {
|
||||
@@ -211,7 +211,7 @@
|
||||
"workflow-pack": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-new-skill-or-agent.md"
|
||||
".claude/commands/add-new-skill.md"
|
||||
]
|
||||
},
|
||||
"files": [
|
||||
@@ -297,8 +297,8 @@
|
||||
},
|
||||
{
|
||||
"moduleId": "workflow-pack",
|
||||
"path": ".claude/commands/add-new-skill-or-agent.md",
|
||||
"description": "Workflow command scaffold for add-new-skill-or-agent."
|
||||
"path": ".claude/commands/add-new-skill.md",
|
||||
"description": "Workflow command scaffold for add-new-skill."
|
||||
}
|
||||
],
|
||||
"workflows": [
|
||||
@@ -311,8 +311,8 @@
|
||||
"path": ".claude/commands/refactoring.md"
|
||||
},
|
||||
{
|
||||
"command": "add-new-skill-or-agent",
|
||||
"path": ".claude/commands/add-new-skill-or-agent.md"
|
||||
"command": "add-new-skill",
|
||||
"path": ".claude/commands/add-new-skill.md"
|
||||
}
|
||||
],
|
||||
"adapters": {
|
||||
@@ -322,7 +322,7 @@
|
||||
"commandPaths": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-new-skill-or-agent.md"
|
||||
".claude/commands/add-new-skill.md"
|
||||
]
|
||||
},
|
||||
"codex": {
|
||||
|
||||
@@ -10,5 +10,5 @@
|
||||
"javascript"
|
||||
],
|
||||
"suggestedBy": "ecc-tools-repo-analysis",
|
||||
"createdAt": "2026-04-02T03:27:09.077Z"
|
||||
"createdAt": "2026-04-02T03:21:37.492Z"
|
||||
}
|
||||
@@ -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-or-agent: Adds a new skill or agent to the codebase, including documentation and registration in manifests and index files.
|
||||
- add-new-skill: Adds a new skill to the system, including documentation and registration in relevant indexes.
|
||||
|
||||
## Review Reminder
|
||||
|
||||
|
||||
@@ -5,184 +5,161 @@
|
||||
|
||||
## Overview
|
||||
|
||||
This skill introduces the core development patterns, coding conventions, and collaborative workflows used in the `everything-claude-code` JavaScript repository. It covers how to add new skills or agents, update commands, manage install targets, maintain tests, update documentation, automate hooks, and handle dependency updates. Following these patterns ensures consistency, maintainability, and ease of collaboration across the codebase.
|
||||
|
||||
---
|
||||
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.
|
||||
|
||||
## Coding Conventions
|
||||
|
||||
**File Naming**
|
||||
- Use `camelCase` for JavaScript files and folders.
|
||||
- Example: `installManifests.js`, `voiceProfileSchema.md`
|
||||
- Use `camelCase` for JavaScript files and directories.
|
||||
- Example: `mySkill.js`, `installTarget.js`
|
||||
|
||||
**Import Style**
|
||||
- Use relative imports.
|
||||
- Example:
|
||||
```js
|
||||
const installManifests = require('./installManifests');
|
||||
const helper = require('./helper');
|
||||
import { doSomething } from '../utils/doSomething';
|
||||
```
|
||||
|
||||
**Export Style**
|
||||
- Mixed: Both CommonJS (`module.exports`) and ES6 (`export`) styles are present.
|
||||
- Mixed: both CommonJS (`module.exports`) and ES6 (`export`) exports are used.
|
||||
- Example (CommonJS):
|
||||
```js
|
||||
module.exports = function doSomething() { ... };
|
||||
module.exports = function myFunction() { ... };
|
||||
```
|
||||
- Example (ES6):
|
||||
```js
|
||||
export function doSomething() { ... }
|
||||
export function myFunction() { ... }
|
||||
```
|
||||
|
||||
**Commit Messages**
|
||||
- Use [Conventional Commits](https://www.conventionalcommits.org/).
|
||||
- Prefixes: `fix`, `feat`, `docs`, `chore`
|
||||
- Example:
|
||||
```
|
||||
feat: add voice profile schema reference for new agent
|
||||
```
|
||||
|
||||
---
|
||||
- Use [Conventional Commits](https://www.conventionalcommits.org/):
|
||||
- Prefixes: `fix`, `feat`, `docs`, `chore`
|
||||
- Example: `feat: add new agent pipeline for document processing`
|
||||
|
||||
## Workflows
|
||||
|
||||
### Add New Skill or Agent
|
||||
**Trigger:** When introducing a new skill or agent to the system
|
||||
### Add New Skill
|
||||
**Trigger:** When introducing a new skill (capability/module) to the platform
|
||||
**Command:** `/add-skill`
|
||||
|
||||
1. Create or update `SKILL.md` in `skills/<skill-name>/` or `.agents/skills/<skill-name>/`.
|
||||
2. Add or update documentation files (`README.md`, `AGENTS.md`, `docs/zh-CN/AGENTS.md`, etc.).
|
||||
3. Register the new skill/agent in `manifests/install-components.json` or `manifests/install-modules.json`.
|
||||
4. Optionally, add reference files or assets (e.g., `references/voice-profile-schema.md`, `assets/`).
|
||||
5. If adding an agent, create `agents/<agent-name>.md`.
|
||||
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`.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
# Add a new skill called "voiceProfile"
|
||||
mkdir -p skills/voiceProfile
|
||||
touch skills/voiceProfile/SKILL.md
|
||||
# Edit manifests/install-components.json to register
|
||||
**Example directory structure:**
|
||||
```
|
||||
skills/
|
||||
myNewSkill/
|
||||
SKILL.md
|
||||
index.js
|
||||
assets/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update Command Workflow
|
||||
**Trigger:** When adding or improving a CLI command
|
||||
### Add New Agent or Pipeline
|
||||
**Trigger:** When introducing a new agent or orchestrated workflow (pipeline)
|
||||
**Command:** `/add-agent-pipeline`
|
||||
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
### Add or Extend Command
|
||||
**Trigger:** When adding or enhancing CLI commands
|
||||
**Command:** `/add-command`
|
||||
|
||||
1. Create or update `commands/<command-name>.md` with YAML frontmatter, usage, and implementation details.
|
||||
2. Update related documentation (`README.md`, `AGENTS.md`).
|
||||
3. Update or add corresponding skill or agent documentation if relevant.
|
||||
|
||||
**Example:**
|
||||
```markdown
|
||||
# commands/review.md
|
||||
|
||||
---
|
||||
name: review
|
||||
description: Run code review workflow
|
||||
---
|
||||
|
||||
## Usage
|
||||
...
|
||||
```
|
||||
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 IDE, tool, or platform for installation
|
||||
**Trigger:** When supporting a new install target (plugin, IDE, platform)
|
||||
**Command:** `/add-install-target`
|
||||
|
||||
1. Create install scripts and documentation in a new folder (e.g., `.codebuddy/`, `.gemini/`).
|
||||
2. Add or update install-manifests and registry scripts (`scripts/lib/install-manifests.js`, `scripts/lib/install-targets/*.js`).
|
||||
3. Update schemas (`schemas/ecc-install-config.schema.json`, `schemas/install-modules.schema.json`).
|
||||
4. Register the new target in `manifests/install-modules.json`.
|
||||
5. Add or update tests for install targets.
|
||||
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:**
|
||||
```js
|
||||
// scripts/lib/install-targets/codebuddy.js
|
||||
module.exports = function installCodebuddy() { ... };
|
||||
```
|
||||
.codebuddy/
|
||||
install.sh
|
||||
uninstall.sh
|
||||
README.md
|
||||
scripts/lib/install-targets/codebuddy.js
|
||||
tests/lib/install-targets.test.js
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Update or Fix Tests
|
||||
**Trigger:** When fixing or updating tests for compatibility or new features
|
||||
**Command:** `/fix-test`
|
||||
|
||||
1. Edit test files in `tests/scripts/` or `tests/lib/` to address issues (e.g., path normalization, environment variables).
|
||||
2. Update implementation files if needed to support the test fix.
|
||||
3. Document the fix in the commit message.
|
||||
|
||||
**Example:**
|
||||
```js
|
||||
// tests/lib/install-targets.test.js
|
||||
test('should normalize Windows paths', () => {
|
||||
...
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Documentation and Guidance Update
|
||||
**Trigger:** When improving or updating documentation for users or contributors
|
||||
**Command:** `/update-docs`
|
||||
|
||||
1. Edit or add files like `README.md`, `WORKING-CONTEXT.md`, `AGENTS.md`, `the-shortform-guide.md`, and `docs/zh-CN/*`.
|
||||
2. Synchronize documentation across English and Chinese versions.
|
||||
3. Update or add troubleshooting guides and best practices.
|
||||
|
||||
---
|
||||
|
||||
### Update Hooks or Automation Scripts
|
||||
**Trigger:** When improving repo hooks or automation scripts
|
||||
### Update or Harden Hooks
|
||||
**Trigger:** When improving, refactoring, or fixing hooks (e.g., CI, formatting, session management)
|
||||
**Command:** `/update-hook`
|
||||
|
||||
1. Edit `hooks/hooks.json` to add or update hook definitions.
|
||||
2. Update or add scripts in `scripts/hooks/` or `scripts/lib/`.
|
||||
3. Update or add tests for hooks in `tests/hooks/`.
|
||||
4. Document changes in commit messages.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
### Dependency Update via Dependabot
|
||||
**Trigger:** When dependencies are bumped by dependabot or maintainers
|
||||
**Command:** `/bump-dep`
|
||||
### Documentation Sync and Guidance Update
|
||||
**Trigger:** When updating documentation to reflect new features, skills, or workflows
|
||||
**Command:** `/sync-docs`
|
||||
|
||||
1. Update dependency version in `package.json` or workflow YAML.
|
||||
2. Update lockfile (`yarn.lock` or `package-lock.json`).
|
||||
3. Commit with standardized message (`chore(deps): ...`).
|
||||
4. Update related workflow files if needed (`.github/workflows/*.yml`).
|
||||
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` and are located in `tests/scripts/` and `tests/lib/`.
|
||||
- Testing framework is not explicitly specified; use standard Node.js test runners (e.g., Jest, Mocha).
|
||||
- Tests focus on platform compatibility, feature coverage, and regression prevention.
|
||||
|
||||
**Example:**
|
||||
```js
|
||||
// tests/scripts/installScript.test.js
|
||||
describe('installScript', () => {
|
||||
it('should handle environment variables', () => {
|
||||
...
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
- 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 or agent, including docs and registration |
|
||||
| /add-command | Add or update a CLI command and its documentation |
|
||||
| /add-install-target | Add a new install target or adapter for integration |
|
||||
| /fix-test | Fix or update test files for compatibility or new features |
|
||||
| /update-docs | Update documentation and guidance files |
|
||||
| /update-hook | Update hooks or automation scripts |
|
||||
| /bump-dep | Bump dependency versions via dependabot or manually |
|
||||
| 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 |
|
||||
```
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
"commandFiles": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-new-skill-or-agent.md"
|
||||
".claude/commands/add-new-skill.md"
|
||||
],
|
||||
"updatedAt": "2026-04-02T03:26:28.561Z"
|
||||
"updatedAt": "2026-04-02T03:20:48.238Z"
|
||||
}
|
||||
Reference in New Issue
Block a user