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 | |
|---|---|---|---|
|
f4cd4a0d82 | ||
|
|
cda05058ea | ||
|
|
bf512d9b02 | ||
|
|
7d2fddd34c | ||
|
|
552afdf258 | ||
|
|
77f131bd9c | ||
|
|
ff498bd224 | ||
|
|
85db58afe5 | ||
|
|
fe4e42457e | ||
|
|
5a2392cf40 | ||
|
|
bb2614dc13 | ||
|
|
ee376c6926 | ||
|
|
6e8e5af539 | ||
|
|
f642cb0e31 | ||
|
|
ba8fa7484b |
@@ -5,199 +5,170 @@
|
||||
|
||||
## 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` repository. The project is a JavaScript codebase (no framework detected) focused on modular skills, agent orchestration, automation workflows, and extensible install targets. It emphasizes clear documentation, conventional commits, and a structured approach to adding new capabilities.
|
||||
|
||||
## Coding Conventions
|
||||
|
||||
**Language:** JavaScript
|
||||
**Framework:** None detected
|
||||
- **File Naming:**
|
||||
Use `camelCase` for JavaScript files and directories.
|
||||
_Example:_
|
||||
```
|
||||
installTargetProject.js
|
||||
agentPipeline.md
|
||||
```
|
||||
|
||||
### File Naming
|
||||
- **Import Style:**
|
||||
Use **relative imports** for modules within the codebase.
|
||||
_Example:_
|
||||
```js
|
||||
const installTarget = require('../lib/install-targets/codeBuddy-project.js');
|
||||
```
|
||||
|
||||
- Use **camelCase** for file names.
|
||||
- Example: `mySkillHandler.js`, `installTargetManager.js`
|
||||
- **Export Style:**
|
||||
Mixed usage of CommonJS (`module.exports`) and ES module (`export`) patterns, depending on context.
|
||||
_Example (CommonJS):_
|
||||
```js
|
||||
module.exports = function installTarget() { ... };
|
||||
```
|
||||
_Example (ESM):_
|
||||
```js
|
||||
export function installTarget() { ... }
|
||||
```
|
||||
|
||||
### Import Style
|
||||
|
||||
- Use **relative imports** for modules within the repository.
|
||||
- Example:
|
||||
```js
|
||||
const utils = require('./utils');
|
||||
import { runTest } from '../testHelpers';
|
||||
```
|
||||
|
||||
### Export Style
|
||||
|
||||
- **Mixed**: Both CommonJS (`module.exports`) and ES module (`export`) styles may be present.
|
||||
- Example (CommonJS):
|
||||
```js
|
||||
module.exports = function doSomething() { ... };
|
||||
```
|
||||
- Example (ES Module):
|
||||
```js
|
||||
export function doSomethingElse() { ... }
|
||||
```
|
||||
|
||||
### Commit Messages
|
||||
|
||||
- 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
|
||||
```
|
||||
- **Commit Messages:**
|
||||
Use [Conventional Commits](https://www.conventionalcommits.org/) with prefixes: `fix`, `feat`, `docs`, `chore`.
|
||||
_Example:_
|
||||
```
|
||||
feat: add support for new agent pipeline
|
||||
fix: correct install script path resolution
|
||||
```
|
||||
|
||||
## Workflows
|
||||
|
||||
### Add New Skill
|
||||
**Trigger:** When introducing a new skill (capability, workflow, or integration) to the platform
|
||||
**Trigger:** When you want to add a new skill (capability, agent, or workflow)
|
||||
**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 a new `SKILL.md` file under `skills/<skill-name>/` or `.agents/skills/<skill-name>/`.
|
||||
2. Optionally add related reference files (schemas, assets) in the skill directory.
|
||||
3. Update documentation files to reference the new skill:
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
4. Optionally update install manifests (e.g., `manifests/install-components.json`) if the skill is installable.
|
||||
|
||||
**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
|
||||
_Example directory structure:_
|
||||
```
|
||||
skills/myNewSkill/SKILL.md
|
||||
skills/myNewSkill/schema.json
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 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 New Command or Workflow
|
||||
**Trigger:** When introducing a new command-line workflow or process
|
||||
**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 a new markdown file under `commands/` (e.g., `commands/myWorkflow.md`).
|
||||
2. Document the workflow with YAML frontmatter, usage, and output sections.
|
||||
3. Update `AGENTS.md`, `README.md`, or other summary files to reference the new command.
|
||||
4. Optionally update scripts or examples if automation is included.
|
||||
|
||||
**Example:**
|
||||
_Example:_
|
||||
```markdown
|
||||
---
|
||||
name: summarize
|
||||
description: Summarizes input text using the summarizer agent.
|
||||
name: santa-loop
|
||||
description: Automates the Santa workflow
|
||||
---
|
||||
# Usage
|
||||
...
|
||||
# santa-loop
|
||||
Usage: ...
|
||||
```
|
||||
|
||||
---
|
||||
### Add New Agent or Agent Pipeline
|
||||
**Trigger:** When adding a new agent or multi-agent pipeline
|
||||
**Command:** `/add-agent-pipeline`
|
||||
|
||||
### Add New Install Target or Adapter
|
||||
**Trigger:** When supporting a new install target (platform, IDE, or agent runtime)
|
||||
1. Create agent definition markdown files under `agents/` (e.g., `agents/myAgent.md`).
|
||||
2. Optionally, create a new orchestrator skill under `skills/<pipeline>/SKILL.md`.
|
||||
3. Update `AGENTS.md` and `README.md` to reference the new agent(s) or pipeline.
|
||||
4. Optionally add example or configuration files.
|
||||
|
||||
_Example:_
|
||||
```
|
||||
agents/opensource-pipeline.md
|
||||
skills/opensource-pipeline/SKILL.md
|
||||
```
|
||||
|
||||
### Add or Update Install Target
|
||||
**Trigger:** When supporting a new install target (IDE, platform) or updating install logic
|
||||
**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. Add or update install scripts and documentation under `.<target>/`.
|
||||
2. Update `manifests/install-modules.json` and related schemas.
|
||||
3. Add or update scripts in `scripts/lib/install-targets/<target>-project.js`.
|
||||
4. Update registry and test files as needed.
|
||||
5. Update `README.md` or other summary docs.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
mkdir .codebuddy
|
||||
touch .codebuddy/README.md
|
||||
_Example:_
|
||||
```
|
||||
.codeBuddy/install.sh
|
||||
scripts/lib/install-targets/codeBuddy-project.js
|
||||
```
|
||||
|
||||
---
|
||||
### Update or Add Hooks and Automation
|
||||
**Trigger:** When modifying or extending hooks and automation scripts
|
||||
**Command:** `/update-hooks`
|
||||
|
||||
### Update Hooks or Hook Scripts
|
||||
**Trigger:** When changing how hooks are triggered, processed, or validated
|
||||
**Command:** `/update-hook`
|
||||
1. Edit `hooks/hooks.json` to add or update hook definitions.
|
||||
2. Modify or create scripts in `scripts/hooks/*.js` for hook logic.
|
||||
3. Update or add related test files under `tests/hooks/`.
|
||||
4. Optionally update `.cursor/hooks/` or other adapter-specific files.
|
||||
|
||||
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.
|
||||
|
||||
**Example:**
|
||||
_Example:_
|
||||
```json
|
||||
// hooks/hooks.json
|
||||
{
|
||||
"pre-commit": ["scripts/hooks/format.js"]
|
||||
"pre-commit": "node scripts/hooks/format.js"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Dependency Update via Dependabot
|
||||
**Trigger:** When a new version of a dependency is available
|
||||
**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-authored-by dependabot.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
npm install some-package@latest
|
||||
git commit -m "chore: bump some-package to 1.2.3"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Docs and Guidance Update
|
||||
**Trigger:** When improving or adding documentation or guidance
|
||||
### Documentation and Guidance Update
|
||||
**Trigger:** When updating documentation or adding new 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.
|
||||
1. Edit or create markdown files in the repo root or `docs/` directories.
|
||||
2. Update `WORKING-CONTEXT.md` to reflect current practices.
|
||||
3. Update or add `README.md`, `README.zh-CN.md`, and `AGENTS.md`.
|
||||
4. Optionally update `.claude-plugin/` or `.codex-plugin/` README files.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
vim README.md
|
||||
git commit -m "docs: clarify agent pipeline usage"
|
||||
```
|
||||
### Test or CI Fix
|
||||
**Trigger:** When fixing or improving tests and CI integration
|
||||
**Command:** `/fix-test`
|
||||
|
||||
1. Edit test files under `tests/`.
|
||||
2. Optionally edit scripts or hooks related to the test.
|
||||
3. Update CI workflow files under `.github/workflows/` if needed.
|
||||
|
||||
## 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.');
|
||||
});
|
||||
```
|
||||
- **Test Framework:** Not explicitly specified; test files follow the `*.test.js` pattern.
|
||||
- **Test File Location:** Place test files under `tests/`, mirroring the structure of the code they test.
|
||||
- **Example:**
|
||||
```
|
||||
tests/lib/install-targets.test.js
|
||||
tests/hooks/format.test.js
|
||||
```
|
||||
- **Running Tests:**
|
||||
Ensure your tests are named with `.test.js` and can be run via your preferred test runner (e.g., `node`, `jest`, etc.).
|
||||
|
||||
## 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 (capability, agent, or workflow) |
|
||||
| /add-command | Add a new command or workflow |
|
||||
| /add-agent-pipeline| Add a new agent or multi-agent pipeline |
|
||||
| /add-install-target| Add or update an install target (IDE, platform, plugin host) |
|
||||
| /update-hooks | Update or add hooks and automation scripts |
|
||||
| /update-docs | Update documentation and guidance |
|
||||
| /fix-test | Fix or improve tests and CI integration |
|
||||
```
|
||||
|
||||
@@ -10,7 +10,7 @@ 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.
|
||||
Adds a new skill to the system, including documentation and references in summary/index files.
|
||||
|
||||
## Common Files
|
||||
|
||||
@@ -30,10 +30,10 @@ Adds a new skill to the system, including documentation and sometimes references
|
||||
|
||||
## 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
|
||||
- Create a new SKILL.md file under skills/<skill-name>/ or .agents/skills/<skill-name>/
|
||||
- Optionally add related reference files (e.g., schemas, assets) under the skill directory
|
||||
- Update AGENTS.md, README.md, README.zh-CN.md, and docs/zh-CN/AGENTS.md to reference the new skill
|
||||
- Optionally update manifests/install-*.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:59.009Z",
|
||||
"generatedAt": "2026-04-02T03:26:25.798Z",
|
||||
"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:40.334Z"
|
||||
"createdAt": "2026-04-02T03:27:07.927Z"
|
||||
}
|
||||
@@ -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: Adds a new skill to the system, including documentation and references in summary/index files.
|
||||
|
||||
## Review Reminder
|
||||
|
||||
|
||||
@@ -5,199 +5,170 @@
|
||||
|
||||
## 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` repository. The project is a JavaScript codebase (no framework detected) focused on modular skills, agent orchestration, automation workflows, and extensible install targets. It emphasizes clear documentation, conventional commits, and a structured approach to adding new capabilities.
|
||||
|
||||
## Coding Conventions
|
||||
|
||||
**Language:** JavaScript
|
||||
**Framework:** None detected
|
||||
- **File Naming:**
|
||||
Use `camelCase` for JavaScript files and directories.
|
||||
_Example:_
|
||||
```
|
||||
installTargetProject.js
|
||||
agentPipeline.md
|
||||
```
|
||||
|
||||
### File Naming
|
||||
- **Import Style:**
|
||||
Use **relative imports** for modules within the codebase.
|
||||
_Example:_
|
||||
```js
|
||||
const installTarget = require('../lib/install-targets/codeBuddy-project.js');
|
||||
```
|
||||
|
||||
- Use **camelCase** for file names.
|
||||
- Example: `mySkillHandler.js`, `installTargetManager.js`
|
||||
- **Export Style:**
|
||||
Mixed usage of CommonJS (`module.exports`) and ES module (`export`) patterns, depending on context.
|
||||
_Example (CommonJS):_
|
||||
```js
|
||||
module.exports = function installTarget() { ... };
|
||||
```
|
||||
_Example (ESM):_
|
||||
```js
|
||||
export function installTarget() { ... }
|
||||
```
|
||||
|
||||
### Import Style
|
||||
|
||||
- Use **relative imports** for modules within the repository.
|
||||
- Example:
|
||||
```js
|
||||
const utils = require('./utils');
|
||||
import { runTest } from '../testHelpers';
|
||||
```
|
||||
|
||||
### Export Style
|
||||
|
||||
- **Mixed**: Both CommonJS (`module.exports`) and ES module (`export`) styles may be present.
|
||||
- Example (CommonJS):
|
||||
```js
|
||||
module.exports = function doSomething() { ... };
|
||||
```
|
||||
- Example (ES Module):
|
||||
```js
|
||||
export function doSomethingElse() { ... }
|
||||
```
|
||||
|
||||
### Commit Messages
|
||||
|
||||
- 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
|
||||
```
|
||||
- **Commit Messages:**
|
||||
Use [Conventional Commits](https://www.conventionalcommits.org/) with prefixes: `fix`, `feat`, `docs`, `chore`.
|
||||
_Example:_
|
||||
```
|
||||
feat: add support for new agent pipeline
|
||||
fix: correct install script path resolution
|
||||
```
|
||||
|
||||
## Workflows
|
||||
|
||||
### Add New Skill
|
||||
**Trigger:** When introducing a new skill (capability, workflow, or integration) to the platform
|
||||
**Trigger:** When you want to add a new skill (capability, agent, or workflow)
|
||||
**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 a new `SKILL.md` file under `skills/<skill-name>/` or `.agents/skills/<skill-name>/`.
|
||||
2. Optionally add related reference files (schemas, assets) in the skill directory.
|
||||
3. Update documentation files to reference the new skill:
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
4. Optionally update install manifests (e.g., `manifests/install-components.json`) if the skill is installable.
|
||||
|
||||
**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
|
||||
_Example directory structure:_
|
||||
```
|
||||
skills/myNewSkill/SKILL.md
|
||||
skills/myNewSkill/schema.json
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 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 New Command or Workflow
|
||||
**Trigger:** When introducing a new command-line workflow or process
|
||||
**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 a new markdown file under `commands/` (e.g., `commands/myWorkflow.md`).
|
||||
2. Document the workflow with YAML frontmatter, usage, and output sections.
|
||||
3. Update `AGENTS.md`, `README.md`, or other summary files to reference the new command.
|
||||
4. Optionally update scripts or examples if automation is included.
|
||||
|
||||
**Example:**
|
||||
_Example:_
|
||||
```markdown
|
||||
---
|
||||
name: summarize
|
||||
description: Summarizes input text using the summarizer agent.
|
||||
name: santa-loop
|
||||
description: Automates the Santa workflow
|
||||
---
|
||||
# Usage
|
||||
...
|
||||
# santa-loop
|
||||
Usage: ...
|
||||
```
|
||||
|
||||
---
|
||||
### Add New Agent or Agent Pipeline
|
||||
**Trigger:** When adding a new agent or multi-agent pipeline
|
||||
**Command:** `/add-agent-pipeline`
|
||||
|
||||
### Add New Install Target or Adapter
|
||||
**Trigger:** When supporting a new install target (platform, IDE, or agent runtime)
|
||||
1. Create agent definition markdown files under `agents/` (e.g., `agents/myAgent.md`).
|
||||
2. Optionally, create a new orchestrator skill under `skills/<pipeline>/SKILL.md`.
|
||||
3. Update `AGENTS.md` and `README.md` to reference the new agent(s) or pipeline.
|
||||
4. Optionally add example or configuration files.
|
||||
|
||||
_Example:_
|
||||
```
|
||||
agents/opensource-pipeline.md
|
||||
skills/opensource-pipeline/SKILL.md
|
||||
```
|
||||
|
||||
### Add or Update Install Target
|
||||
**Trigger:** When supporting a new install target (IDE, platform) or updating install logic
|
||||
**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. Add or update install scripts and documentation under `.<target>/`.
|
||||
2. Update `manifests/install-modules.json` and related schemas.
|
||||
3. Add or update scripts in `scripts/lib/install-targets/<target>-project.js`.
|
||||
4. Update registry and test files as needed.
|
||||
5. Update `README.md` or other summary docs.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
mkdir .codebuddy
|
||||
touch .codebuddy/README.md
|
||||
_Example:_
|
||||
```
|
||||
.codeBuddy/install.sh
|
||||
scripts/lib/install-targets/codeBuddy-project.js
|
||||
```
|
||||
|
||||
---
|
||||
### Update or Add Hooks and Automation
|
||||
**Trigger:** When modifying or extending hooks and automation scripts
|
||||
**Command:** `/update-hooks`
|
||||
|
||||
### Update Hooks or Hook Scripts
|
||||
**Trigger:** When changing how hooks are triggered, processed, or validated
|
||||
**Command:** `/update-hook`
|
||||
1. Edit `hooks/hooks.json` to add or update hook definitions.
|
||||
2. Modify or create scripts in `scripts/hooks/*.js` for hook logic.
|
||||
3. Update or add related test files under `tests/hooks/`.
|
||||
4. Optionally update `.cursor/hooks/` or other adapter-specific files.
|
||||
|
||||
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.
|
||||
|
||||
**Example:**
|
||||
_Example:_
|
||||
```json
|
||||
// hooks/hooks.json
|
||||
{
|
||||
"pre-commit": ["scripts/hooks/format.js"]
|
||||
"pre-commit": "node scripts/hooks/format.js"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Dependency Update via Dependabot
|
||||
**Trigger:** When a new version of a dependency is available
|
||||
**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-authored-by dependabot.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
npm install some-package@latest
|
||||
git commit -m "chore: bump some-package to 1.2.3"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Docs and Guidance Update
|
||||
**Trigger:** When improving or adding documentation or guidance
|
||||
### Documentation and Guidance Update
|
||||
**Trigger:** When updating documentation or adding new 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.
|
||||
1. Edit or create markdown files in the repo root or `docs/` directories.
|
||||
2. Update `WORKING-CONTEXT.md` to reflect current practices.
|
||||
3. Update or add `README.md`, `README.zh-CN.md`, and `AGENTS.md`.
|
||||
4. Optionally update `.claude-plugin/` or `.codex-plugin/` README files.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
vim README.md
|
||||
git commit -m "docs: clarify agent pipeline usage"
|
||||
```
|
||||
### Test or CI Fix
|
||||
**Trigger:** When fixing or improving tests and CI integration
|
||||
**Command:** `/fix-test`
|
||||
|
||||
1. Edit test files under `tests/`.
|
||||
2. Optionally edit scripts or hooks related to the test.
|
||||
3. Update CI workflow files under `.github/workflows/` if needed.
|
||||
|
||||
## 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.');
|
||||
});
|
||||
```
|
||||
- **Test Framework:** Not explicitly specified; test files follow the `*.test.js` pattern.
|
||||
- **Test File Location:** Place test files under `tests/`, mirroring the structure of the code they test.
|
||||
- **Example:**
|
||||
```
|
||||
tests/lib/install-targets.test.js
|
||||
tests/hooks/format.test.js
|
||||
```
|
||||
- **Running Tests:**
|
||||
Ensure your tests are named with `.test.js` and can be run via your preferred test runner (e.g., `node`, `jest`, etc.).
|
||||
|
||||
## 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 (capability, agent, or workflow) |
|
||||
| /add-command | Add a new command or workflow |
|
||||
| /add-agent-pipeline| Add a new agent or multi-agent pipeline |
|
||||
| /add-install-target| Add or update an install target (IDE, platform, plugin host) |
|
||||
| /update-hooks | Update or add hooks and automation scripts |
|
||||
| /update-docs | Update documentation and guidance |
|
||||
| /fix-test | Fix or improve tests and CI integration |
|
||||
```
|
||||
|
||||
@@ -11,5 +11,5 @@
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-new-skill.md"
|
||||
],
|
||||
"updatedAt": "2026-04-02T03:20:59.009Z"
|
||||
"updatedAt": "2026-04-02T03:26:25.798Z"
|
||||
}
|
||||
Reference in New Issue
Block a user