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 | |
|---|---|---|---|
|
de69c1a185 | ||
|
|
4f62974cf9 | ||
|
|
f2626a58a7 | ||
|
|
cbba258cdc | ||
|
|
a7d5d3c6b7 | ||
|
|
071115564b | ||
|
|
9bfdb9204e | ||
|
|
cfeecbb85b | ||
|
|
1fa8dfb6a2 | ||
|
|
3576048bdb | ||
|
|
b4a051da4d | ||
|
|
c4c0e2bbdc | ||
|
|
ed88f861d2 | ||
|
|
cecee5a712 | ||
|
|
ca22779d6a |
@@ -5,199 +5,184 @@
|
||||
|
||||
## Overview
|
||||
|
||||
This skill introduces the core development patterns, workflows, and conventions used in the `everything-claude-code` repository. It covers how to contribute new skills, agents, commands, install targets, and documentation, as well as how to follow the project's coding and commit standards. This guide is essential for consistent, high-quality contributions to the codebase.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
## Coding Conventions
|
||||
|
||||
**Language:** JavaScript
|
||||
**Framework:** None detected
|
||||
**File Naming**
|
||||
- Use `camelCase` for JavaScript files and folders.
|
||||
- Example: `installManifests.js`, `voiceProfileSchema.md`
|
||||
|
||||
### File Naming
|
||||
|
||||
- Use **camelCase** for file names.
|
||||
- Example: `mySkillHandler.js`, `installTargetManager.js`
|
||||
|
||||
### Import Style
|
||||
|
||||
- Use **relative imports** for modules within the repository.
|
||||
**Import Style**
|
||||
- Use relative imports.
|
||||
- Example:
|
||||
```js
|
||||
const utils = require('./utils');
|
||||
import { runTest } from '../testHelpers';
|
||||
const installManifests = require('./installManifests');
|
||||
```
|
||||
|
||||
### Export Style
|
||||
|
||||
- **Mixed**: Both CommonJS (`module.exports`) and ES module (`export`) styles may be present.
|
||||
**Export Style**
|
||||
- Mixed: Both CommonJS (`module.exports`) and ES6 (`export`) styles are present.
|
||||
- Example (CommonJS):
|
||||
```js
|
||||
module.exports = function doSomething() { ... };
|
||||
```
|
||||
- Example (ES Module):
|
||||
- Example (ES6):
|
||||
```js
|
||||
export function doSomethingElse() { ... }
|
||||
export function doSomething() { ... }
|
||||
```
|
||||
|
||||
### Commit Messages
|
||||
**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 commit** prefixes: `fix`, `feat`, `docs`, `chore`.
|
||||
- Average commit message length: ~56 characters.
|
||||
- Example:
|
||||
```
|
||||
feat: add new agent pipeline for document summarization
|
||||
fix: correct import path in installTargetManager.js
|
||||
```
|
||||
---
|
||||
|
||||
## Workflows
|
||||
|
||||
### Add New Skill
|
||||
**Trigger:** When introducing a new skill (capability, workflow, or integration) to the platform
|
||||
### Add New Skill or Agent
|
||||
**Trigger:** When introducing a new skill or agent to the system
|
||||
**Command:** `/add-skill`
|
||||
|
||||
1. Create or update `skills/<skill-name>/SKILL.md` (and/or `.agents/skills/<skill-name>/SKILL.md`).
|
||||
2. Optionally add related references or assets (e.g., `references/`, `assets/`).
|
||||
3. Update documentation: `AGENTS.md`, `README.md`, `README.zh-CN.md`, and `docs/zh-CN/AGENTS.md`.
|
||||
4. If the skill is installable, update `manifests/install-components.json` or `install-modules.json`.
|
||||
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`.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
# Add a new skill called "summarizer"
|
||||
mkdir -p skills/summarizer
|
||||
touch skills/summarizer/SKILL.md
|
||||
# Document the skill and update manifests if needed
|
||||
# Add a new skill called "voiceProfile"
|
||||
mkdir -p skills/voiceProfile
|
||||
touch skills/voiceProfile/SKILL.md
|
||||
# Edit manifests/install-components.json to register
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add New Agent or Agent Pipeline
|
||||
**Trigger:** When adding a new agent or multi-agent workflow to the system
|
||||
**Command:** `/add-agent-pipeline`
|
||||
|
||||
1. Create `agents/<agent-name>.md` for each new agent.
|
||||
2. Create or update `skills/<pipeline-or-skill-name>/SKILL.md` to document/orchestrate the pipeline.
|
||||
3. Optionally add related commands (`commands/<command>.md`) or scripts.
|
||||
4. Update `AGENTS.md` and related documentation.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
touch agents/summarizerAgent.md
|
||||
touch skills/summarizerPipeline/SKILL.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Extend Command Workflow
|
||||
**Trigger:** When adding or updating a workflow command (e.g., PRP, review, GAN)
|
||||
### Add or Update Command Workflow
|
||||
**Trigger:** When adding or improving a CLI command
|
||||
**Command:** `/add-command`
|
||||
|
||||
1. Create or update `commands/<command-name>.md` with YAML frontmatter, usage, and output sections.
|
||||
2. Iterate on the command file to address review feedback.
|
||||
3. Optionally update related skills or agent documentation.
|
||||
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: summarize
|
||||
description: Summarizes input text using the summarizer agent.
|
||||
name: review
|
||||
description: Run code review workflow
|
||||
---
|
||||
# Usage
|
||||
|
||||
## Usage
|
||||
...
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add New Install Target or Adapter
|
||||
**Trigger:** When supporting a new install target (platform, IDE, or agent runtime)
|
||||
### Add Install Target or Adapter
|
||||
**Trigger:** When supporting a new IDE, tool, or platform for installation
|
||||
**Command:** `/add-install-target`
|
||||
|
||||
1. Add a new directory for the install target (e.g., `.codebuddy/`, `.gemini/`).
|
||||
2. Add install/uninstall scripts and README files.
|
||||
3. Update `manifests/install-modules.json` and `schemas/ecc-install-config.schema.json`.
|
||||
4. Update scripts in `scripts/lib/install-manifests.js` and `scripts/lib/install-targets/<target>.js`.
|
||||
5. Update or add tests for the new 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.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
mkdir .codebuddy
|
||||
touch .codebuddy/README.md
|
||||
```js
|
||||
// scripts/lib/install-targets/codebuddy.js
|
||||
module.exports = function installCodebuddy() { ... };
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Update Hooks or Hook Scripts
|
||||
**Trigger:** When changing how hooks are triggered, processed, or validated
|
||||
**Command:** `/update-hook`
|
||||
### Update or Fix Tests
|
||||
**Trigger:** When fixing or updating tests for compatibility or new features
|
||||
**Command:** `/fix-test`
|
||||
|
||||
1. Edit `hooks/hooks.json` to add, remove, or modify hook definitions.
|
||||
2. Update or add scripts in `scripts/hooks/` (e.g., `session-start.js`, `post-edit-accumulator.js`).
|
||||
3. Update or add tests in `tests/hooks/`.
|
||||
4. Optionally update related documentation or configuration.
|
||||
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:**
|
||||
```json
|
||||
// hooks/hooks.json
|
||||
{
|
||||
"pre-commit": ["scripts/hooks/format.js"]
|
||||
}
|
||||
```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
|
||||
**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.
|
||||
|
||||
---
|
||||
|
||||
### Dependency Update via Dependabot
|
||||
**Trigger:** When a new version of a dependency is available
|
||||
**Command:** `/bump-dependency`
|
||||
**Trigger:** When dependencies are bumped by dependabot or maintainers
|
||||
**Command:** `/bump-dep`
|
||||
|
||||
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-authored-by dependabot.
|
||||
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`).
|
||||
|
||||
---
|
||||
|
||||
## 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:**
|
||||
```bash
|
||||
npm install some-package@latest
|
||||
git commit -m "chore: bump some-package to 1.2.3"
|
||||
```js
|
||||
// tests/scripts/installScript.test.js
|
||||
describe('installScript', () => {
|
||||
it('should handle environment variables', () => {
|
||||
...
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Docs and Guidance Update
|
||||
**Trigger:** When improving or adding documentation or guidance
|
||||
**Command:** `/update-docs`
|
||||
|
||||
1. Edit or add markdown files in the root, `docs/`, or `skills/` directories.
|
||||
2. Update `WORKING-CONTEXT.md`, `AGENTS.md`, `README.md`, and/or `docs/zh-CN/*`.
|
||||
3. Optionally update plugin or skill documentation.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
vim README.md
|
||||
git commit -m "docs: clarify agent pipeline usage"
|
||||
```
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
- **Test files:** Use the `*.test.js` pattern.
|
||||
- **Testing framework:** Not explicitly detected; use standard Node.js testing or your preferred framework.
|
||||
- **Location:** Tests are typically placed alongside implementation files or in a `tests/` directory.
|
||||
|
||||
**Example:**
|
||||
```js
|
||||
// skills/summarizer/summarizer.test.js
|
||||
const summarizer = require('./summarizer');
|
||||
|
||||
test('summarizes text', () => {
|
||||
expect(summarizer('This is a long text.')).toBe('Summary.');
|
||||
});
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Purpose |
|
||||
|--------------------|------------------------------------------------------------|
|
||||
| /add-skill | Add a new skill, including documentation and assets |
|
||||
| /add-agent-pipeline| Add a new agent or multi-agent pipeline |
|
||||
| /add-command | Add or extend a workflow command |
|
||||
| /add-install-target| Add support for a new install target or adapter |
|
||||
| /update-hook | Update hooks or hook scripts |
|
||||
| /bump-dependency | Update dependencies via Dependabot |
|
||||
| /update-docs | Update documentation or guidance |
|
||||
| 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 |
|
||||
```
|
||||
|
||||
42
.claude/commands/add-new-skill-or-agent.md
Normal file
42
.claude/commands/add-new-skill-or-agent.md
Normal file
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: add-new-skill-or-agent
|
||||
description: Workflow command scaffold for add-new-skill-or-agent in everything-claude-code.
|
||||
allowed_tools: ["Bash", "Read", "Write", "Grep", "Glob"]
|
||||
---
|
||||
|
||||
# /add-new-skill-or-agent
|
||||
|
||||
Use this workflow when working on **add-new-skill-or-agent** in `everything-claude-code`.
|
||||
|
||||
## Goal
|
||||
|
||||
Adds a new skill or agent to the codebase, including documentation and registration in manifests and index files.
|
||||
|
||||
## Common Files
|
||||
|
||||
- `skills/*/SKILL.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
|
||||
## Suggested Sequence
|
||||
|
||||
1. Understand the current state and failure mode before editing.
|
||||
2. Make the smallest coherent change that satisfies the workflow goal.
|
||||
3. Run the most relevant verification for touched files.
|
||||
4. Summarize what changed and what still needs review.
|
||||
|
||||
## 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
|
||||
|
||||
## Notes
|
||||
|
||||
- Treat this as a scaffold, not a hard-coded script.
|
||||
- Update the command if the workflow evolves materially.
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
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
|
||||
|
||||
Use this workflow when working on **add-new-skill** in `everything-claude-code`.
|
||||
|
||||
## Goal
|
||||
|
||||
Adds a new skill to the system, including documentation and sometimes references/assets.
|
||||
|
||||
## Common Files
|
||||
|
||||
- `skills/*/SKILL.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
|
||||
## Suggested Sequence
|
||||
|
||||
1. Understand the current state and failure mode before editing.
|
||||
2. Make the smallest coherent change that satisfies the workflow goal.
|
||||
3. Run the most relevant verification for touched files.
|
||||
4. Summarize what changed and what still needs review.
|
||||
|
||||
## Typical Commit Signals
|
||||
|
||||
- Create or update skills/<skill-name>/SKILL.md (and/or .agents/skills/<skill-name>/SKILL.md)
|
||||
- Optionally add related references or assets (e.g., references/, assets/)
|
||||
- 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 install-modules.json if the skill is installable
|
||||
|
||||
## Notes
|
||||
|
||||
- Treat this as a scaffold, not a hard-coded script.
|
||||
- Update the command if the workflow evolves materially.
|
||||
@@ -2,7 +2,7 @@
|
||||
"version": "1.3",
|
||||
"schemaVersion": "1.0",
|
||||
"generatedBy": "ecc-tools",
|
||||
"generatedAt": "2026-04-02T03:20:59.009Z",
|
||||
"generatedAt": "2026-04-02T03:26:28.561Z",
|
||||
"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.md"
|
||||
".claude/commands/add-new-skill-or-agent.md"
|
||||
],
|
||||
"packageFiles": {
|
||||
"runtime-core": [
|
||||
@@ -180,7 +180,7 @@
|
||||
"workflow-pack": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-new-skill.md"
|
||||
".claude/commands/add-new-skill-or-agent.md"
|
||||
]
|
||||
},
|
||||
"moduleFiles": {
|
||||
@@ -211,7 +211,7 @@
|
||||
"workflow-pack": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-new-skill.md"
|
||||
".claude/commands/add-new-skill-or-agent.md"
|
||||
]
|
||||
},
|
||||
"files": [
|
||||
@@ -297,8 +297,8 @@
|
||||
},
|
||||
{
|
||||
"moduleId": "workflow-pack",
|
||||
"path": ".claude/commands/add-new-skill.md",
|
||||
"description": "Workflow command scaffold for add-new-skill."
|
||||
"path": ".claude/commands/add-new-skill-or-agent.md",
|
||||
"description": "Workflow command scaffold for add-new-skill-or-agent."
|
||||
}
|
||||
],
|
||||
"workflows": [
|
||||
@@ -311,8 +311,8 @@
|
||||
"path": ".claude/commands/refactoring.md"
|
||||
},
|
||||
{
|
||||
"command": "add-new-skill",
|
||||
"path": ".claude/commands/add-new-skill.md"
|
||||
"command": "add-new-skill-or-agent",
|
||||
"path": ".claude/commands/add-new-skill-or-agent.md"
|
||||
}
|
||||
],
|
||||
"adapters": {
|
||||
@@ -322,7 +322,7 @@
|
||||
"commandPaths": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-new-skill.md"
|
||||
".claude/commands/add-new-skill-or-agent.md"
|
||||
]
|
||||
},
|
||||
"codex": {
|
||||
|
||||
@@ -10,5 +10,5 @@
|
||||
"javascript"
|
||||
],
|
||||
"suggestedBy": "ecc-tools-repo-analysis",
|
||||
"createdAt": "2026-04-02T03:21:40.334Z"
|
||||
"createdAt": "2026-04-02T03:27:09.077Z"
|
||||
}
|
||||
@@ -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 sometimes references/assets.
|
||||
- add-new-skill-or-agent: Adds a new skill or agent to the codebase, including documentation and registration in manifests and index files.
|
||||
|
||||
## Review Reminder
|
||||
|
||||
|
||||
@@ -5,199 +5,184 @@
|
||||
|
||||
## Overview
|
||||
|
||||
This skill introduces the core development patterns, workflows, and conventions used in the `everything-claude-code` repository. It covers how to contribute new skills, agents, commands, install targets, and documentation, as well as how to follow the project's coding and commit standards. This guide is essential for consistent, high-quality contributions to the codebase.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
## Coding Conventions
|
||||
|
||||
**Language:** JavaScript
|
||||
**Framework:** None detected
|
||||
**File Naming**
|
||||
- Use `camelCase` for JavaScript files and folders.
|
||||
- Example: `installManifests.js`, `voiceProfileSchema.md`
|
||||
|
||||
### File Naming
|
||||
|
||||
- Use **camelCase** for file names.
|
||||
- Example: `mySkillHandler.js`, `installTargetManager.js`
|
||||
|
||||
### Import Style
|
||||
|
||||
- Use **relative imports** for modules within the repository.
|
||||
**Import Style**
|
||||
- Use relative imports.
|
||||
- Example:
|
||||
```js
|
||||
const utils = require('./utils');
|
||||
import { runTest } from '../testHelpers';
|
||||
const installManifests = require('./installManifests');
|
||||
```
|
||||
|
||||
### Export Style
|
||||
|
||||
- **Mixed**: Both CommonJS (`module.exports`) and ES module (`export`) styles may be present.
|
||||
**Export Style**
|
||||
- Mixed: Both CommonJS (`module.exports`) and ES6 (`export`) styles are present.
|
||||
- Example (CommonJS):
|
||||
```js
|
||||
module.exports = function doSomething() { ... };
|
||||
```
|
||||
- Example (ES Module):
|
||||
- Example (ES6):
|
||||
```js
|
||||
export function doSomethingElse() { ... }
|
||||
export function doSomething() { ... }
|
||||
```
|
||||
|
||||
### Commit Messages
|
||||
**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 commit** prefixes: `fix`, `feat`, `docs`, `chore`.
|
||||
- Average commit message length: ~56 characters.
|
||||
- Example:
|
||||
```
|
||||
feat: add new agent pipeline for document summarization
|
||||
fix: correct import path in installTargetManager.js
|
||||
```
|
||||
---
|
||||
|
||||
## Workflows
|
||||
|
||||
### Add New Skill
|
||||
**Trigger:** When introducing a new skill (capability, workflow, or integration) to the platform
|
||||
### Add New Skill or Agent
|
||||
**Trigger:** When introducing a new skill or agent to the system
|
||||
**Command:** `/add-skill`
|
||||
|
||||
1. Create or update `skills/<skill-name>/SKILL.md` (and/or `.agents/skills/<skill-name>/SKILL.md`).
|
||||
2. Optionally add related references or assets (e.g., `references/`, `assets/`).
|
||||
3. Update documentation: `AGENTS.md`, `README.md`, `README.zh-CN.md`, and `docs/zh-CN/AGENTS.md`.
|
||||
4. If the skill is installable, update `manifests/install-components.json` or `install-modules.json`.
|
||||
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`.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
# Add a new skill called "summarizer"
|
||||
mkdir -p skills/summarizer
|
||||
touch skills/summarizer/SKILL.md
|
||||
# Document the skill and update manifests if needed
|
||||
# Add a new skill called "voiceProfile"
|
||||
mkdir -p skills/voiceProfile
|
||||
touch skills/voiceProfile/SKILL.md
|
||||
# Edit manifests/install-components.json to register
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add New Agent or Agent Pipeline
|
||||
**Trigger:** When adding a new agent or multi-agent workflow to the system
|
||||
**Command:** `/add-agent-pipeline`
|
||||
|
||||
1. Create `agents/<agent-name>.md` for each new agent.
|
||||
2. Create or update `skills/<pipeline-or-skill-name>/SKILL.md` to document/orchestrate the pipeline.
|
||||
3. Optionally add related commands (`commands/<command>.md`) or scripts.
|
||||
4. Update `AGENTS.md` and related documentation.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
touch agents/summarizerAgent.md
|
||||
touch skills/summarizerPipeline/SKILL.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Extend Command Workflow
|
||||
**Trigger:** When adding or updating a workflow command (e.g., PRP, review, GAN)
|
||||
### Add or Update Command Workflow
|
||||
**Trigger:** When adding or improving a CLI command
|
||||
**Command:** `/add-command`
|
||||
|
||||
1. Create or update `commands/<command-name>.md` with YAML frontmatter, usage, and output sections.
|
||||
2. Iterate on the command file to address review feedback.
|
||||
3. Optionally update related skills or agent documentation.
|
||||
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: summarize
|
||||
description: Summarizes input text using the summarizer agent.
|
||||
name: review
|
||||
description: Run code review workflow
|
||||
---
|
||||
# Usage
|
||||
|
||||
## Usage
|
||||
...
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add New Install Target or Adapter
|
||||
**Trigger:** When supporting a new install target (platform, IDE, or agent runtime)
|
||||
### Add Install Target or Adapter
|
||||
**Trigger:** When supporting a new IDE, tool, or platform for installation
|
||||
**Command:** `/add-install-target`
|
||||
|
||||
1. Add a new directory for the install target (e.g., `.codebuddy/`, `.gemini/`).
|
||||
2. Add install/uninstall scripts and README files.
|
||||
3. Update `manifests/install-modules.json` and `schemas/ecc-install-config.schema.json`.
|
||||
4. Update scripts in `scripts/lib/install-manifests.js` and `scripts/lib/install-targets/<target>.js`.
|
||||
5. Update or add tests for the new 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.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
mkdir .codebuddy
|
||||
touch .codebuddy/README.md
|
||||
```js
|
||||
// scripts/lib/install-targets/codebuddy.js
|
||||
module.exports = function installCodebuddy() { ... };
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Update Hooks or Hook Scripts
|
||||
**Trigger:** When changing how hooks are triggered, processed, or validated
|
||||
**Command:** `/update-hook`
|
||||
### Update or Fix Tests
|
||||
**Trigger:** When fixing or updating tests for compatibility or new features
|
||||
**Command:** `/fix-test`
|
||||
|
||||
1. Edit `hooks/hooks.json` to add, remove, or modify hook definitions.
|
||||
2. Update or add scripts in `scripts/hooks/` (e.g., `session-start.js`, `post-edit-accumulator.js`).
|
||||
3. Update or add tests in `tests/hooks/`.
|
||||
4. Optionally update related documentation or configuration.
|
||||
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:**
|
||||
```json
|
||||
// hooks/hooks.json
|
||||
{
|
||||
"pre-commit": ["scripts/hooks/format.js"]
|
||||
}
|
||||
```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
|
||||
**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.
|
||||
|
||||
---
|
||||
|
||||
### Dependency Update via Dependabot
|
||||
**Trigger:** When a new version of a dependency is available
|
||||
**Command:** `/bump-dependency`
|
||||
**Trigger:** When dependencies are bumped by dependabot or maintainers
|
||||
**Command:** `/bump-dep`
|
||||
|
||||
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-authored-by dependabot.
|
||||
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`).
|
||||
|
||||
---
|
||||
|
||||
## 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:**
|
||||
```bash
|
||||
npm install some-package@latest
|
||||
git commit -m "chore: bump some-package to 1.2.3"
|
||||
```js
|
||||
// tests/scripts/installScript.test.js
|
||||
describe('installScript', () => {
|
||||
it('should handle environment variables', () => {
|
||||
...
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Docs and Guidance Update
|
||||
**Trigger:** When improving or adding documentation or guidance
|
||||
**Command:** `/update-docs`
|
||||
|
||||
1. Edit or add markdown files in the root, `docs/`, or `skills/` directories.
|
||||
2. Update `WORKING-CONTEXT.md`, `AGENTS.md`, `README.md`, and/or `docs/zh-CN/*`.
|
||||
3. Optionally update plugin or skill documentation.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
vim README.md
|
||||
git commit -m "docs: clarify agent pipeline usage"
|
||||
```
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
- **Test files:** Use the `*.test.js` pattern.
|
||||
- **Testing framework:** Not explicitly detected; use standard Node.js testing or your preferred framework.
|
||||
- **Location:** Tests are typically placed alongside implementation files or in a `tests/` directory.
|
||||
|
||||
**Example:**
|
||||
```js
|
||||
// skills/summarizer/summarizer.test.js
|
||||
const summarizer = require('./summarizer');
|
||||
|
||||
test('summarizes text', () => {
|
||||
expect(summarizer('This is a long text.')).toBe('Summary.');
|
||||
});
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Purpose |
|
||||
|--------------------|------------------------------------------------------------|
|
||||
| /add-skill | Add a new skill, including documentation and assets |
|
||||
| /add-agent-pipeline| Add a new agent or multi-agent pipeline |
|
||||
| /add-command | Add or extend a workflow command |
|
||||
| /add-install-target| Add support for a new install target or adapter |
|
||||
| /update-hook | Update hooks or hook scripts |
|
||||
| /bump-dependency | Update dependencies via Dependabot |
|
||||
| /update-docs | Update documentation or guidance |
|
||||
| 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 |
|
||||
```
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
"commandFiles": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-new-skill.md"
|
||||
".claude/commands/add-new-skill-or-agent.md"
|
||||
],
|
||||
"updatedAt": "2026-04-02T03:20:59.009Z"
|
||||
"updatedAt": "2026-04-02T03:26:28.561Z"
|
||||
}
|
||||
Reference in New Issue
Block a user