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,199 +5,161 @@
|
||||
|
||||
## 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 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
|
||||
|
||||
**Language:** JavaScript
|
||||
**Framework:** None detected
|
||||
**File Naming**
|
||||
- Use `camelCase` for JavaScript files and directories.
|
||||
- Example: `mySkill.js`, `installTarget.js`
|
||||
|
||||
### 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 helper = require('./helper');
|
||||
import { doSomething } from '../utils/doSomething';
|
||||
```
|
||||
|
||||
### 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`) exports are used.
|
||||
- Example (CommonJS):
|
||||
```js
|
||||
module.exports = function doSomething() { ... };
|
||||
module.exports = function myFunction() { ... };
|
||||
```
|
||||
- Example (ES Module):
|
||||
- Example (ES6):
|
||||
```js
|
||||
export function doSomethingElse() { ... }
|
||||
export function myFunction() { ... }
|
||||
```
|
||||
|
||||
### 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/):
|
||||
- Prefixes: `fix`, `feat`, `docs`, `chore`
|
||||
- Example: `feat: add new agent pipeline for document processing`
|
||||
|
||||
## Workflows
|
||||
|
||||
### Add New Skill
|
||||
**Trigger:** When introducing a new skill (capability, workflow, or integration) to the platform
|
||||
**Trigger:** When introducing a new skill (capability/module) to the platform
|
||||
**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` 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 "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
|
||||
index.js
|
||||
assets/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add New Agent or Agent Pipeline
|
||||
**Trigger:** When adding a new agent or multi-agent workflow to the system
|
||||
### Add New Agent or Pipeline
|
||||
**Trigger:** When introducing a new agent or orchestrated workflow (pipeline)
|
||||
**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
|
||||
```
|
||||
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 Workflow
|
||||
**Trigger:** When adding or updating a workflow command (e.g., PRP, review, GAN)
|
||||
### 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 output sections.
|
||||
2. Iterate on the command file to address review feedback.
|
||||
3. Optionally update related skills or agent documentation.
|
||||
|
||||
**Example:**
|
||||
```markdown
|
||||
---
|
||||
name: summarize
|
||||
description: Summarizes input text using the summarizer agent.
|
||||
---
|
||||
# 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 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 install target (plugin, IDE, platform)
|
||||
**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 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:**
|
||||
```bash
|
||||
mkdir .codebuddy
|
||||
touch .codebuddy/README.md
|
||||
```
|
||||
.codebuddy/
|
||||
install.sh
|
||||
uninstall.sh
|
||||
README.md
|
||||
scripts/lib/install-targets/codebuddy.js
|
||||
tests/lib/install-targets.test.js
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Update Hooks or Hook Scripts
|
||||
**Trigger:** When changing how hooks are triggered, processed, or validated
|
||||
### 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, 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:**
|
||||
```json
|
||||
// hooks/hooks.json
|
||||
{
|
||||
"pre-commit": ["scripts/hooks/format.js"]
|
||||
}
|
||||
```
|
||||
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 a new version of a dependency is available
|
||||
### Documentation Sync and Guidance Update
|
||||
**Trigger:** When updating documentation to reflect new features, skills, or workflows
|
||||
**Command:** `/sync-docs`
|
||||
|
||||
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-authored-by dependabot.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
npm install some-package@latest
|
||||
git commit -m "chore: bump some-package to 1.2.3"
|
||||
```
|
||||
3. Commit with a standardized message and co-author.
|
||||
|
||||
---
|
||||
|
||||
### 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.');
|
||||
});
|
||||
```
|
||||
- Test files use the pattern `*.test.js`.
|
||||
- Testing framework is not explicitly specified; check test files for usage.
|
||||
- Place tests alongside or within a `tests/` directory, matching the structure of the code under test.
|
||||
- Example test file:
|
||||
```
|
||||
tests/lib/install-targets.test.js
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Purpose |
|
||||
|--------------------|------------------------------------------------------------|
|
||||
| /add-skill | Add a new skill, including 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, 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 |
|
||||
```
|
||||
|
||||
@@ -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 registration in relevant indexes.
|
||||
|
||||
## Common Files
|
||||
|
||||
@@ -30,10 +30,11 @@ 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/)
|
||||
- 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 install-modules.json if the skill is installable
|
||||
- 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:20:59.009Z",
|
||||
"generatedAt": "2026-04-02T03:20:48.238Z",
|
||||
"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: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: 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 registration in relevant indexes.
|
||||
|
||||
## Review Reminder
|
||||
|
||||
|
||||
@@ -5,199 +5,161 @@
|
||||
|
||||
## 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 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
|
||||
|
||||
**Language:** JavaScript
|
||||
**Framework:** None detected
|
||||
**File Naming**
|
||||
- Use `camelCase` for JavaScript files and directories.
|
||||
- Example: `mySkill.js`, `installTarget.js`
|
||||
|
||||
### 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 helper = require('./helper');
|
||||
import { doSomething } from '../utils/doSomething';
|
||||
```
|
||||
|
||||
### 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`) exports are used.
|
||||
- Example (CommonJS):
|
||||
```js
|
||||
module.exports = function doSomething() { ... };
|
||||
module.exports = function myFunction() { ... };
|
||||
```
|
||||
- Example (ES Module):
|
||||
- Example (ES6):
|
||||
```js
|
||||
export function doSomethingElse() { ... }
|
||||
export function myFunction() { ... }
|
||||
```
|
||||
|
||||
### 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/):
|
||||
- Prefixes: `fix`, `feat`, `docs`, `chore`
|
||||
- Example: `feat: add new agent pipeline for document processing`
|
||||
|
||||
## Workflows
|
||||
|
||||
### Add New Skill
|
||||
**Trigger:** When introducing a new skill (capability, workflow, or integration) to the platform
|
||||
**Trigger:** When introducing a new skill (capability/module) to the platform
|
||||
**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` 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 "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
|
||||
index.js
|
||||
assets/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add New Agent or Agent Pipeline
|
||||
**Trigger:** When adding a new agent or multi-agent workflow to the system
|
||||
### Add New Agent or Pipeline
|
||||
**Trigger:** When introducing a new agent or orchestrated workflow (pipeline)
|
||||
**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
|
||||
```
|
||||
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 Workflow
|
||||
**Trigger:** When adding or updating a workflow command (e.g., PRP, review, GAN)
|
||||
### 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 output sections.
|
||||
2. Iterate on the command file to address review feedback.
|
||||
3. Optionally update related skills or agent documentation.
|
||||
|
||||
**Example:**
|
||||
```markdown
|
||||
---
|
||||
name: summarize
|
||||
description: Summarizes input text using the summarizer agent.
|
||||
---
|
||||
# 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 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 install target (plugin, IDE, platform)
|
||||
**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 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:**
|
||||
```bash
|
||||
mkdir .codebuddy
|
||||
touch .codebuddy/README.md
|
||||
```
|
||||
.codebuddy/
|
||||
install.sh
|
||||
uninstall.sh
|
||||
README.md
|
||||
scripts/lib/install-targets/codebuddy.js
|
||||
tests/lib/install-targets.test.js
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Update Hooks or Hook Scripts
|
||||
**Trigger:** When changing how hooks are triggered, processed, or validated
|
||||
### 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, 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:**
|
||||
```json
|
||||
// hooks/hooks.json
|
||||
{
|
||||
"pre-commit": ["scripts/hooks/format.js"]
|
||||
}
|
||||
```
|
||||
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 a new version of a dependency is available
|
||||
### Documentation Sync and Guidance Update
|
||||
**Trigger:** When updating documentation to reflect new features, skills, or workflows
|
||||
**Command:** `/sync-docs`
|
||||
|
||||
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-authored-by dependabot.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
npm install some-package@latest
|
||||
git commit -m "chore: bump some-package to 1.2.3"
|
||||
```
|
||||
3. Commit with a standardized message and co-author.
|
||||
|
||||
---
|
||||
|
||||
### 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.');
|
||||
});
|
||||
```
|
||||
- Test files use the pattern `*.test.js`.
|
||||
- Testing framework is not explicitly specified; check test files for usage.
|
||||
- Place tests alongside or within a `tests/` directory, matching the structure of the code under test.
|
||||
- Example test file:
|
||||
```
|
||||
tests/lib/install-targets.test.js
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Purpose |
|
||||
|--------------------|------------------------------------------------------------|
|
||||
| /add-skill | Add a new skill, including 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, 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 |
|
||||
```
|
||||
|
||||
@@ -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:20:48.238Z"
|
||||
}
|
||||
Reference in New Issue
Block a user