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,170 +5,161 @@
|
||||
|
||||
## Overview
|
||||
|
||||
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.
|
||||
This skill teaches the core development patterns, coding conventions, and collaborative workflows used in the `everything-claude-code` JavaScript repository. The project is modular, skill-oriented, and emphasizes clear documentation, conventional commits, and extensibility via skills, agents, commands, and install targets. This guide will help you contribute effectively by following established patterns and using the right commands for common tasks.
|
||||
|
||||
## Coding Conventions
|
||||
|
||||
- **File Naming:**
|
||||
Use `camelCase` for JavaScript files and directories.
|
||||
_Example:_
|
||||
```
|
||||
installTargetProject.js
|
||||
agentPipeline.md
|
||||
```
|
||||
**File Naming**
|
||||
- Use `camelCase` for JavaScript files and directories.
|
||||
- Example: `mySkill.js`, `installTarget.js`
|
||||
|
||||
- **Import Style:**
|
||||
Use **relative imports** for modules within the codebase.
|
||||
_Example:_
|
||||
```js
|
||||
const installTarget = require('../lib/install-targets/codeBuddy-project.js');
|
||||
```
|
||||
**Import Style**
|
||||
- Use relative imports.
|
||||
- Example:
|
||||
```js
|
||||
const helper = require('./helper');
|
||||
import { doSomething } from '../utils/doSomething';
|
||||
```
|
||||
|
||||
- **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() { ... }
|
||||
```
|
||||
**Export Style**
|
||||
- Mixed: both CommonJS (`module.exports`) and ES6 (`export`) exports are used.
|
||||
- Example (CommonJS):
|
||||
```js
|
||||
module.exports = function myFunction() { ... };
|
||||
```
|
||||
- Example (ES6):
|
||||
```js
|
||||
export function myFunction() { ... }
|
||||
```
|
||||
|
||||
- **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
|
||||
```
|
||||
**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 you want to add a new skill (capability, agent, or workflow)
|
||||
**Trigger:** When introducing a new skill (capability/module) to the platform
|
||||
**Command:** `/add-skill`
|
||||
|
||||
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:
|
||||
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. Optionally update install manifests (e.g., `manifests/install-components.json`) if the skill is installable.
|
||||
4. If the skill is installable, update:
|
||||
- `manifests/install-components.json` or
|
||||
- `manifests/install-modules.json`
|
||||
5. Optionally update `WORKING-CONTEXT.md`.
|
||||
|
||||
_Example directory structure:_
|
||||
**Example directory structure:**
|
||||
```
|
||||
skills/myNewSkill/SKILL.md
|
||||
skills/myNewSkill/schema.json
|
||||
skills/
|
||||
myNewSkill/
|
||||
SKILL.md
|
||||
index.js
|
||||
assets/
|
||||
```
|
||||
|
||||
### Add New Command or Workflow
|
||||
**Trigger:** When introducing a new command-line workflow or process
|
||||
**Command:** `/add-command`
|
||||
|
||||
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:_
|
||||
```markdown
|
||||
---
|
||||
name: santa-loop
|
||||
description: Automates the Santa workflow
|
||||
---
|
||||
# santa-loop
|
||||
Usage: ...
|
||||
```
|
||||
|
||||
### Add New Agent or Agent Pipeline
|
||||
**Trigger:** When adding a new agent or multi-agent pipeline
|
||||
### Add New Agent or Pipeline
|
||||
**Trigger:** When introducing a new agent or orchestrated workflow (pipeline)
|
||||
**Command:** `/add-agent-pipeline`
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
_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
|
||||
### Add or Extend Command
|
||||
**Trigger:** When adding or enhancing CLI commands
|
||||
**Command:** `/add-command`
|
||||
|
||||
1. Create or update command markdown files under `commands/`.
|
||||
2. Incorporate review feedback and fixes as needed.
|
||||
3. Document new commands in `AGENTS.md` or other relevant docs.
|
||||
|
||||
---
|
||||
|
||||
### Add Install Target or Adapter
|
||||
**Trigger:** When supporting a new install target (plugin, IDE, platform)
|
||||
**Command:** `/add-install-target`
|
||||
|
||||
1. 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.
|
||||
1. Create a new directory for the install target (e.g., `.codebuddy/`, `.gemini/`).
|
||||
2. Add install/uninstall scripts and documentation in the new directory.
|
||||
3. Update `manifests/install-modules.json` and relevant schemas.
|
||||
4. Update or add scripts in `scripts/lib/install-targets/<target>.js`.
|
||||
5. Update or add tests for the new install target.
|
||||
|
||||
_Example:_
|
||||
**Example:**
|
||||
```
|
||||
.codeBuddy/install.sh
|
||||
scripts/lib/install-targets/codeBuddy-project.js
|
||||
.codebuddy/
|
||||
install.sh
|
||||
uninstall.sh
|
||||
README.md
|
||||
scripts/lib/install-targets/codebuddy.js
|
||||
tests/lib/install-targets.test.js
|
||||
```
|
||||
|
||||
### Update or Add Hooks and Automation
|
||||
**Trigger:** When modifying or extending hooks and automation scripts
|
||||
**Command:** `/update-hooks`
|
||||
---
|
||||
|
||||
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.
|
||||
### Update or Harden Hooks
|
||||
**Trigger:** When improving, refactoring, or fixing hooks (e.g., CI, formatting, session management)
|
||||
**Command:** `/update-hook`
|
||||
|
||||
_Example:_
|
||||
```json
|
||||
// hooks/hooks.json
|
||||
{
|
||||
"pre-commit": "node 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.
|
||||
|
||||
### Documentation and Guidance Update
|
||||
**Trigger:** When updating documentation or adding new guidance
|
||||
**Command:** `/update-docs`
|
||||
---
|
||||
|
||||
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.
|
||||
### Documentation Sync and Guidance Update
|
||||
**Trigger:** When updating documentation to reflect new features, skills, or workflows
|
||||
**Command:** `/sync-docs`
|
||||
|
||||
### Test or CI Fix
|
||||
**Trigger:** When fixing or improving tests and CI integration
|
||||
**Command:** `/fix-test`
|
||||
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.
|
||||
|
||||
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.
|
||||
---
|
||||
|
||||
### Dependency Bump via Dependabot
|
||||
**Trigger:** When a dependency update is triggered by Dependabot or similar automation
|
||||
**Command:** `/bump-dependency`
|
||||
|
||||
1. Update `package.json` and/or `yarn.lock` for npm dependencies.
|
||||
2. Update `.github/workflows/*.yml` for GitHub Actions dependencies.
|
||||
3. Commit with a standardized message and co-author.
|
||||
|
||||
---
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
- **Test 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:**
|
||||
- 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
|
||||
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 (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 |
|
||||
| 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 references in summary/index files.
|
||||
Adds a new skill to the system, including documentation and registration in relevant indexes.
|
||||
|
||||
## Common Files
|
||||
|
||||
@@ -31,9 +31,10 @@ Adds a new skill to the system, including documentation and references in summar
|
||||
## Typical Commit Signals
|
||||
|
||||
- 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
|
||||
- Optionally add related assets or references under the skill directory
|
||||
- Update AGENTS.md, README.md, README.zh-CN.md, and docs/zh-CN/AGENTS.md to document the new skill
|
||||
- Update manifests/install-components.json or manifests/install-modules.json if the skill is installable
|
||||
- Optionally update WORKING-CONTEXT.md
|
||||
|
||||
## Notes
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
"version": "1.3",
|
||||
"schemaVersion": "1.0",
|
||||
"generatedBy": "ecc-tools",
|
||||
"generatedAt": "2026-04-02T03:26:25.798Z",
|
||||
"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:27:07.927Z"
|
||||
"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 references in summary/index files.
|
||||
- add-new-skill: Adds a new skill to the system, including documentation and registration in relevant indexes.
|
||||
|
||||
## Review Reminder
|
||||
|
||||
|
||||
@@ -5,170 +5,161 @@
|
||||
|
||||
## Overview
|
||||
|
||||
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.
|
||||
This skill teaches the core development patterns, coding conventions, and collaborative workflows used in the `everything-claude-code` JavaScript repository. The project is modular, skill-oriented, and emphasizes clear documentation, conventional commits, and extensibility via skills, agents, commands, and install targets. This guide will help you contribute effectively by following established patterns and using the right commands for common tasks.
|
||||
|
||||
## Coding Conventions
|
||||
|
||||
- **File Naming:**
|
||||
Use `camelCase` for JavaScript files and directories.
|
||||
_Example:_
|
||||
```
|
||||
installTargetProject.js
|
||||
agentPipeline.md
|
||||
```
|
||||
**File Naming**
|
||||
- Use `camelCase` for JavaScript files and directories.
|
||||
- Example: `mySkill.js`, `installTarget.js`
|
||||
|
||||
- **Import Style:**
|
||||
Use **relative imports** for modules within the codebase.
|
||||
_Example:_
|
||||
```js
|
||||
const installTarget = require('../lib/install-targets/codeBuddy-project.js');
|
||||
```
|
||||
**Import Style**
|
||||
- Use relative imports.
|
||||
- Example:
|
||||
```js
|
||||
const helper = require('./helper');
|
||||
import { doSomething } from '../utils/doSomething';
|
||||
```
|
||||
|
||||
- **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() { ... }
|
||||
```
|
||||
**Export Style**
|
||||
- Mixed: both CommonJS (`module.exports`) and ES6 (`export`) exports are used.
|
||||
- Example (CommonJS):
|
||||
```js
|
||||
module.exports = function myFunction() { ... };
|
||||
```
|
||||
- Example (ES6):
|
||||
```js
|
||||
export function myFunction() { ... }
|
||||
```
|
||||
|
||||
- **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
|
||||
```
|
||||
**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 you want to add a new skill (capability, agent, or workflow)
|
||||
**Trigger:** When introducing a new skill (capability/module) to the platform
|
||||
**Command:** `/add-skill`
|
||||
|
||||
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:
|
||||
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. Optionally update install manifests (e.g., `manifests/install-components.json`) if the skill is installable.
|
||||
4. If the skill is installable, update:
|
||||
- `manifests/install-components.json` or
|
||||
- `manifests/install-modules.json`
|
||||
5. Optionally update `WORKING-CONTEXT.md`.
|
||||
|
||||
_Example directory structure:_
|
||||
**Example directory structure:**
|
||||
```
|
||||
skills/myNewSkill/SKILL.md
|
||||
skills/myNewSkill/schema.json
|
||||
skills/
|
||||
myNewSkill/
|
||||
SKILL.md
|
||||
index.js
|
||||
assets/
|
||||
```
|
||||
|
||||
### Add New Command or Workflow
|
||||
**Trigger:** When introducing a new command-line workflow or process
|
||||
**Command:** `/add-command`
|
||||
|
||||
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:_
|
||||
```markdown
|
||||
---
|
||||
name: santa-loop
|
||||
description: Automates the Santa workflow
|
||||
---
|
||||
# santa-loop
|
||||
Usage: ...
|
||||
```
|
||||
|
||||
### Add New Agent or Agent Pipeline
|
||||
**Trigger:** When adding a new agent or multi-agent pipeline
|
||||
### Add New Agent or Pipeline
|
||||
**Trigger:** When introducing a new agent or orchestrated workflow (pipeline)
|
||||
**Command:** `/add-agent-pipeline`
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
_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
|
||||
### Add or Extend Command
|
||||
**Trigger:** When adding or enhancing CLI commands
|
||||
**Command:** `/add-command`
|
||||
|
||||
1. Create or update command markdown files under `commands/`.
|
||||
2. Incorporate review feedback and fixes as needed.
|
||||
3. Document new commands in `AGENTS.md` or other relevant docs.
|
||||
|
||||
---
|
||||
|
||||
### Add Install Target or Adapter
|
||||
**Trigger:** When supporting a new install target (plugin, IDE, platform)
|
||||
**Command:** `/add-install-target`
|
||||
|
||||
1. 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.
|
||||
1. Create a new directory for the install target (e.g., `.codebuddy/`, `.gemini/`).
|
||||
2. Add install/uninstall scripts and documentation in the new directory.
|
||||
3. Update `manifests/install-modules.json` and relevant schemas.
|
||||
4. Update or add scripts in `scripts/lib/install-targets/<target>.js`.
|
||||
5. Update or add tests for the new install target.
|
||||
|
||||
_Example:_
|
||||
**Example:**
|
||||
```
|
||||
.codeBuddy/install.sh
|
||||
scripts/lib/install-targets/codeBuddy-project.js
|
||||
.codebuddy/
|
||||
install.sh
|
||||
uninstall.sh
|
||||
README.md
|
||||
scripts/lib/install-targets/codebuddy.js
|
||||
tests/lib/install-targets.test.js
|
||||
```
|
||||
|
||||
### Update or Add Hooks and Automation
|
||||
**Trigger:** When modifying or extending hooks and automation scripts
|
||||
**Command:** `/update-hooks`
|
||||
---
|
||||
|
||||
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.
|
||||
### Update or Harden Hooks
|
||||
**Trigger:** When improving, refactoring, or fixing hooks (e.g., CI, formatting, session management)
|
||||
**Command:** `/update-hook`
|
||||
|
||||
_Example:_
|
||||
```json
|
||||
// hooks/hooks.json
|
||||
{
|
||||
"pre-commit": "node 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.
|
||||
|
||||
### Documentation and Guidance Update
|
||||
**Trigger:** When updating documentation or adding new guidance
|
||||
**Command:** `/update-docs`
|
||||
---
|
||||
|
||||
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.
|
||||
### Documentation Sync and Guidance Update
|
||||
**Trigger:** When updating documentation to reflect new features, skills, or workflows
|
||||
**Command:** `/sync-docs`
|
||||
|
||||
### Test or CI Fix
|
||||
**Trigger:** When fixing or improving tests and CI integration
|
||||
**Command:** `/fix-test`
|
||||
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.
|
||||
|
||||
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.
|
||||
---
|
||||
|
||||
### Dependency Bump via Dependabot
|
||||
**Trigger:** When a dependency update is triggered by Dependabot or similar automation
|
||||
**Command:** `/bump-dependency`
|
||||
|
||||
1. Update `package.json` and/or `yarn.lock` for npm dependencies.
|
||||
2. Update `.github/workflows/*.yml` for GitHub Actions dependencies.
|
||||
3. Commit with a standardized message and co-author.
|
||||
|
||||
---
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
- **Test 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:**
|
||||
- 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
|
||||
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 (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 |
|
||||
| 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:26:25.798Z"
|
||||
"updatedAt": "2026-04-02T03:20:48.238Z"
|
||||
}
|
||||
Reference in New Issue
Block a user