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 | |
|---|---|---|---|
|
ebe8776253 | ||
|
|
240656547c | ||
|
|
abc2d99e1e | ||
|
|
f27d6aa8d5 | ||
|
|
44d85d9916 | ||
|
|
f60803677a | ||
|
|
0a66c0edb9 | ||
|
|
4a733a4e20 | ||
|
|
94239fa9a3 | ||
|
|
ac2af42761 | ||
|
|
7df118b882 | ||
|
|
e5b726176e | ||
|
|
9fcd5c4660 | ||
|
|
21868f3492 | ||
|
|
5962f0e04b |
@@ -1,433 +1,203 @@
|
||||
---
|
||||
name: everything-claude-code-conventions
|
||||
description: Development conventions and patterns for everything-claude-code. JavaScript project with conventional commits.
|
||||
---
|
||||
```markdown
|
||||
# everything-claude-code Development Patterns
|
||||
|
||||
# Everything Claude Code Conventions
|
||||
|
||||
> Generated from [affaan-m/everything-claude-code](https://github.com/affaan-m/everything-claude-code) on 2026-04-02
|
||||
> Auto-generated skill from repository analysis
|
||||
|
||||
## Overview
|
||||
|
||||
This skill teaches Claude the development patterns and conventions used in everything-claude-code.
|
||||
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.
|
||||
|
||||
## Tech Stack
|
||||
## Coding Conventions
|
||||
|
||||
- **Primary Language**: JavaScript
|
||||
- **Architecture**: hybrid module organization
|
||||
- **Test Location**: separate
|
||||
**Language:** JavaScript
|
||||
**Framework:** None detected
|
||||
|
||||
## When to Use This Skill
|
||||
### File Naming
|
||||
|
||||
Activate this skill when:
|
||||
- Making changes to this repository
|
||||
- Adding new features following established patterns
|
||||
- Writing tests that match project conventions
|
||||
- Creating commits with proper message format
|
||||
- Use **camelCase** for file names.
|
||||
- Example: `mySkillHandler.js`, `installTargetManager.js`
|
||||
|
||||
## Commit Conventions
|
||||
### Import Style
|
||||
|
||||
Follow these commit message conventions based on 500 analyzed commits.
|
||||
- Use **relative imports** for modules within the repository.
|
||||
- Example:
|
||||
```js
|
||||
const utils = require('./utils');
|
||||
import { runTest } from '../testHelpers';
|
||||
```
|
||||
|
||||
### Commit Style: Conventional Commits
|
||||
### Export Style
|
||||
|
||||
### Prefixes Used
|
||||
- **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() { ... }
|
||||
```
|
||||
|
||||
- `fix`
|
||||
- `feat`
|
||||
- `docs`
|
||||
- `chore`
|
||||
### Commit Messages
|
||||
|
||||
### Message Guidelines
|
||||
- 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
|
||||
```
|
||||
|
||||
- Average message length: ~57 characters
|
||||
- Keep first line concise and descriptive
|
||||
- Use imperative mood ("Add feature" not "Added feature")
|
||||
## Workflows
|
||||
|
||||
### Add New Skill
|
||||
**Trigger:** When introducing a new skill (capability, workflow, or integration) to the platform
|
||||
**Command:** `/add-skill`
|
||||
|
||||
*Commit message example*
|
||||
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`.
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code-conventions ECC bundle (.claude/commands/add-or-update-skill.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
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix: port safe ci cleanup from backlog
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
refactor: collapse legacy command bodies into skills
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
docs: close bundle drift and sync plugin guidance
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
chore: ignore local orchestration artifacts
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code-conventions ECC bundle (.claude/commands/refactoring.md)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code-conventions ECC bundle (.claude/commands/feature-development.md)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code-conventions ECC bundle (.claude/enterprise/controls.md)
|
||||
```
|
||||
|
||||
## Architecture
|
||||
|
||||
### Project Structure: Single Package
|
||||
|
||||
This project uses **hybrid** module organization.
|
||||
|
||||
### Configuration Files
|
||||
|
||||
- `.github/workflows/ci.yml`
|
||||
- `.github/workflows/maintenance.yml`
|
||||
- `.github/workflows/monthly-metrics.yml`
|
||||
- `.github/workflows/release.yml`
|
||||
- `.github/workflows/reusable-release.yml`
|
||||
- `.github/workflows/reusable-test.yml`
|
||||
- `.github/workflows/reusable-validate.yml`
|
||||
- `.opencode/package.json`
|
||||
- `.opencode/tsconfig.json`
|
||||
- `.prettierrc`
|
||||
- `eslint.config.js`
|
||||
- `package.json`
|
||||
|
||||
### Guidelines
|
||||
|
||||
- This project uses a hybrid organization
|
||||
- Follow existing patterns when adding new code
|
||||
|
||||
## Code Style
|
||||
|
||||
### Language: JavaScript
|
||||
|
||||
### Naming Conventions
|
||||
|
||||
| Element | Convention |
|
||||
|---------|------------|
|
||||
| Files | camelCase |
|
||||
| Functions | camelCase |
|
||||
| Classes | PascalCase |
|
||||
| Constants | SCREAMING_SNAKE_CASE |
|
||||
|
||||
### Import Style: Relative Imports
|
||||
|
||||
### Export Style: Mixed Style
|
||||
|
||||
|
||||
*Preferred import style*
|
||||
|
||||
```typescript
|
||||
// Use relative imports
|
||||
import { Button } from '../components/Button'
|
||||
import { useAuth } from './hooks/useAuth'
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
### Test Framework
|
||||
|
||||
No specific test framework detected — use the repository's existing test patterns.
|
||||
|
||||
### File Pattern: `*.test.js`
|
||||
|
||||
### Test Types
|
||||
|
||||
- **Unit tests**: Test individual functions and components in isolation
|
||||
- **Integration tests**: Test interactions between multiple components/services
|
||||
|
||||
### Coverage
|
||||
|
||||
This project has coverage reporting configured. Aim for 80%+ coverage.
|
||||
|
||||
|
||||
## Error Handling
|
||||
|
||||
### Error Handling Style: Try-Catch Blocks
|
||||
|
||||
|
||||
*Standard error handling pattern*
|
||||
|
||||
```typescript
|
||||
try {
|
||||
const result = await riskyOperation()
|
||||
return result
|
||||
} catch (error) {
|
||||
console.error('Operation failed:', error)
|
||||
throw new Error('User-friendly message')
|
||||
}
|
||||
```
|
||||
|
||||
## Common Workflows
|
||||
|
||||
These workflows were detected from analyzing commit patterns.
|
||||
|
||||
### Feature Development
|
||||
|
||||
Standard feature implementation workflow
|
||||
|
||||
**Frequency**: ~19 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add feature implementation
|
||||
2. Add tests for feature
|
||||
3. Update documentation
|
||||
|
||||
**Files typically involved**:
|
||||
- `.opencode/*`
|
||||
- `.opencode/plugins/*`
|
||||
- `.opencode/plugins/lib/*`
|
||||
- `**/*.test.*`
|
||||
- `**/api/**`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
feat(agents,skills): add opensource-pipeline — 3-agent workflow for safe public releases (#1036)
|
||||
feat(install): add CodeBuddy(Tencent) adaptation with installation scripts (#1038)
|
||||
chore(deps-dev): bump c8 from 10.1.3 to 11.0.0 (#1065)
|
||||
```
|
||||
|
||||
### Refactoring
|
||||
|
||||
Code refactoring and cleanup workflow
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Ensure tests pass before refactor
|
||||
2. Refactor code structure
|
||||
3. Verify tests still pass
|
||||
|
||||
**Files typically involved**:
|
||||
- `src/**/*`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
refactor: collapse legacy command bodies into skills
|
||||
feat: add connected operator workflow skills
|
||||
feat: expand lead intelligence outreach channels
|
||||
```
|
||||
|
||||
### Add Or Update Skill
|
||||
|
||||
Adds or updates a skill module, including documentation and references, and registers it in manifests and documentation.
|
||||
|
||||
**Frequency**: ~4 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or update SKILL.md in skills/<skill-name>/ or .agents/skills/<skill-name>/
|
||||
2. Optionally add or update references or assets under skills/<skill-name>/references/ or assets/
|
||||
3. Update manifests/install-modules.json and/or manifests/install-components.json
|
||||
4. Update AGENTS.md, README.md, README.zh-CN.md, and docs/zh-CN/* as needed
|
||||
5. Update WORKING-CONTEXT.md if context changes
|
||||
6. Optionally update or create related test files
|
||||
|
||||
**Files typically involved**:
|
||||
- `skills/*/SKILL.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `skills/*/references/*.md`
|
||||
- `skills/*/assets/*`
|
||||
- `manifests/install-modules.json`
|
||||
- `manifests/install-components.json`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
- `docs/zh-CN/README.md`
|
||||
- `WORKING-CONTEXT.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or update SKILL.md in skills/<skill-name>/ or .agents/skills/<skill-name>/
|
||||
Optionally add or update references or assets under skills/<skill-name>/references/ or assets/
|
||||
Update manifests/install-modules.json and/or manifests/install-components.json
|
||||
Update AGENTS.md, README.md, README.zh-CN.md, and docs/zh-CN/* as needed
|
||||
Update WORKING-CONTEXT.md if context changes
|
||||
Optionally update or create related test files
|
||||
```
|
||||
|
||||
### Add Or Update Command Workflow
|
||||
|
||||
Adds or updates command documentation and workflow scripts for agentic or PRP workflows.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or update command markdown files under commands/ (e.g., prp-prd.md, code-review.md)
|
||||
2. If extending, update related commands (e.g., plan.md cross-references prp-plan.md)
|
||||
3. Address review feedback and iterate on command logic and documentation
|
||||
|
||||
**Files typically involved**:
|
||||
- `commands/*.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or update command markdown files under commands/ (e.g., prp-prd.md, code-review.md)
|
||||
If extending, update related commands (e.g., plan.md cross-references prp-plan.md)
|
||||
Address review feedback and iterate on command logic and documentation
|
||||
```
|
||||
|
||||
### Add Or Update Agent Or Agent Prompt
|
||||
|
||||
Adds or updates agent configuration, prompt files, and registers agents in orchestration manifests.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or update agent prompt files under .opencode/prompts/agents/
|
||||
2. Update .opencode/opencode.json to register or modify agent configuration
|
||||
3. Update AGENTS.md to document the new or updated agent
|
||||
|
||||
**Files typically involved**:
|
||||
- `.opencode/prompts/agents/*.txt`
|
||||
- `.opencode/opencode.json`
|
||||
- `AGENTS.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or update agent prompt files under .opencode/prompts/agents/
|
||||
Update .opencode/opencode.json to register or modify agent configuration
|
||||
Update AGENTS.md to document the new or updated agent
|
||||
```
|
||||
|
||||
### Feature Development Skill And Docs
|
||||
|
||||
Implements a new feature or workflow by adding skills, updating documentation, and synchronizing manifests and context.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add or update SKILL.md and related files in skills/ or .agents/skills/
|
||||
2. Update or create supporting documentation (README.md, AGENTS.md, docs/zh-CN/*, WORKING-CONTEXT.md)
|
||||
3. Update manifests/install-modules.json and/or manifests/install-components.json
|
||||
4. Synchronize or update related scripts or test files
|
||||
|
||||
**Files typically involved**:
|
||||
- `skills/*/SKILL.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
- `docs/zh-CN/README.md`
|
||||
- `WORKING-CONTEXT.md`
|
||||
- `manifests/install-modules.json`
|
||||
- `manifests/install-components.json`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Add or update SKILL.md and related files in skills/ or .agents/skills/
|
||||
Update or create supporting documentation (README.md, AGENTS.md, docs/zh-CN/*, WORKING-CONTEXT.md)
|
||||
Update manifests/install-modules.json and/or manifests/install-components.json
|
||||
Synchronize or update related scripts or test files
|
||||
```
|
||||
|
||||
### Refactor Or Sync Manifests And Context
|
||||
|
||||
Refactors commands, skills, or agents and synchronizes manifests and working context documentation.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Update or remove command files under commands/
|
||||
2. Update or create SKILL.md files as needed
|
||||
3. Update manifests/install-modules.json and/or install-components.json
|
||||
4. Update AGENTS.md, README.md, README.zh-CN.md, docs/zh-CN/*, WORKING-CONTEXT.md
|
||||
|
||||
**Files typically involved**:
|
||||
- `commands/*.md`
|
||||
- `skills/*/SKILL.md`
|
||||
- `manifests/install-modules.json`
|
||||
- `manifests/install-components.json`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
- `docs/zh-CN/README.md`
|
||||
- `WORKING-CONTEXT.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Update or remove command files under commands/
|
||||
Update or create SKILL.md files as needed
|
||||
Update manifests/install-modules.json and/or install-components.json
|
||||
Update AGENTS.md, README.md, README.zh-CN.md, docs/zh-CN/*, WORKING-CONTEXT.md
|
||||
```
|
||||
|
||||
### Add Or Update Install Target
|
||||
|
||||
Adds or updates an install target (e.g., CodeBuddy, Gemini) with scripts, schemas, and manifest registration.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add or update install/uninstall scripts under .<target>/
|
||||
2. Update or create README files for the target
|
||||
3. Update schemas (ecc-install-config.schema.json, install-modules.schema.json)
|
||||
4. Update scripts/lib/install-targets/<target>-project.js and registry.js
|
||||
5. Update manifests/install-modules.json
|
||||
6. Update or add related test files
|
||||
|
||||
**Files typically involved**:
|
||||
- `.<target>/*`
|
||||
- `manifests/install-modules.json`
|
||||
- `schemas/ecc-install-config.schema.json`
|
||||
- `schemas/install-modules.schema.json`
|
||||
- `scripts/lib/install-manifests.js`
|
||||
- `scripts/lib/install-targets/<target>-project.js`
|
||||
- `scripts/lib/install-targets/registry.js`
|
||||
- `tests/lib/install-targets.test.js`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Add or update install/uninstall scripts under .<target>/
|
||||
Update or create README files for the target
|
||||
Update schemas (ecc-install-config.schema.json, install-modules.schema.json)
|
||||
Update scripts/lib/install-targets/<target>-project.js and registry.js
|
||||
Update manifests/install-modules.json
|
||||
Update or add related test files
|
||||
```
|
||||
|
||||
|
||||
## Best Practices
|
||||
|
||||
Based on analysis of the codebase, follow these practices:
|
||||
|
||||
### Do
|
||||
|
||||
- Use conventional commit format (feat:, fix:, etc.)
|
||||
- Follow *.test.js naming pattern
|
||||
- Use camelCase for file names
|
||||
- Prefer mixed exports
|
||||
|
||||
### Don't
|
||||
|
||||
- Don't write vague commit messages
|
||||
- Don't skip tests for new features
|
||||
- Don't deviate from established patterns without discussion
|
||||
|
||||
---
|
||||
|
||||
*This skill was auto-generated by [ECC Tools](https://ecc.tools). Review and customize as needed for your team.*
|
||||
### 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)
|
||||
**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
|
||||
...
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add New Install Target or Adapter
|
||||
**Trigger:** When supporting a new install target (platform, IDE, or agent runtime)
|
||||
**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.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
mkdir .codebuddy
|
||||
touch .codebuddy/README.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 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, 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"]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 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
|
||||
**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 |
|
||||
```
|
||||
|
||||
41
.claude/commands/add-new-skill.md
Normal file
41
.claude/commands/add-new-skill.md
Normal file
@@ -0,0 +1,41 @@
|
||||
---
|
||||
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.
|
||||
@@ -1,42 +0,0 @@
|
||||
---
|
||||
name: add-or-update-skill
|
||||
description: Workflow command scaffold for add-or-update-skill in everything-claude-code.
|
||||
allowed_tools: ["Bash", "Read", "Write", "Grep", "Glob"]
|
||||
---
|
||||
|
||||
# /add-or-update-skill
|
||||
|
||||
Use this workflow when working on **add-or-update-skill** in `everything-claude-code`.
|
||||
|
||||
## Goal
|
||||
|
||||
Adds or updates a skill module, including documentation and references, and registers it in manifests and documentation.
|
||||
|
||||
## Common Files
|
||||
|
||||
- `skills/*/SKILL.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `skills/*/references/*.md`
|
||||
- `skills/*/assets/*`
|
||||
- `manifests/install-modules.json`
|
||||
- `manifests/install-components.json`
|
||||
|
||||
## 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>/
|
||||
- Optionally add or update references or assets under skills/<skill-name>/references/ or assets/
|
||||
- Update manifests/install-modules.json and/or manifests/install-components.json
|
||||
- Update AGENTS.md, README.md, README.zh-CN.md, and docs/zh-CN/* as needed
|
||||
- Update WORKING-CONTEXT.md if context changes
|
||||
|
||||
## 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:14:01.196Z",
|
||||
"generatedAt": "2026-04-02T03:20:59.009Z",
|
||||
"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-or-update-skill.md"
|
||||
".claude/commands/add-new-skill.md"
|
||||
],
|
||||
"packageFiles": {
|
||||
"runtime-core": [
|
||||
@@ -180,7 +180,7 @@
|
||||
"workflow-pack": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-or-update-skill.md"
|
||||
".claude/commands/add-new-skill.md"
|
||||
]
|
||||
},
|
||||
"moduleFiles": {
|
||||
@@ -211,7 +211,7 @@
|
||||
"workflow-pack": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-or-update-skill.md"
|
||||
".claude/commands/add-new-skill.md"
|
||||
]
|
||||
},
|
||||
"files": [
|
||||
@@ -297,8 +297,8 @@
|
||||
},
|
||||
{
|
||||
"moduleId": "workflow-pack",
|
||||
"path": ".claude/commands/add-or-update-skill.md",
|
||||
"description": "Workflow command scaffold for add-or-update-skill."
|
||||
"path": ".claude/commands/add-new-skill.md",
|
||||
"description": "Workflow command scaffold for add-new-skill."
|
||||
}
|
||||
],
|
||||
"workflows": [
|
||||
@@ -311,8 +311,8 @@
|
||||
"path": ".claude/commands/refactoring.md"
|
||||
},
|
||||
{
|
||||
"command": "add-or-update-skill",
|
||||
"path": ".claude/commands/add-or-update-skill.md"
|
||||
"command": "add-new-skill",
|
||||
"path": ".claude/commands/add-new-skill.md"
|
||||
}
|
||||
],
|
||||
"adapters": {
|
||||
@@ -322,7 +322,7 @@
|
||||
"commandPaths": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-or-update-skill.md"
|
||||
".claude/commands/add-new-skill.md"
|
||||
]
|
||||
},
|
||||
"codex": {
|
||||
|
||||
@@ -10,5 +10,5 @@
|
||||
"javascript"
|
||||
],
|
||||
"suggestedBy": "ecc-tools-repo-analysis",
|
||||
"createdAt": "2026-04-02T03:20:17.389Z"
|
||||
"createdAt": "2026-04-02T03:21:40.334Z"
|
||||
}
|
||||
@@ -18,4 +18,4 @@ Use this when the task is documentation-heavy, source-sensitive, or requires bro
|
||||
|
||||
- Primary language: JavaScript
|
||||
- Framework: Not detected
|
||||
- Workflows detected: 8
|
||||
- Workflows detected: 9
|
||||
@@ -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-or-update-skill: Adds or updates a skill module, including documentation and references, and registers it in manifests and documentation.
|
||||
- add-new-skill: Adds a new skill to the system, including documentation and sometimes references/assets.
|
||||
|
||||
## Review Reminder
|
||||
|
||||
|
||||
@@ -1,433 +1,203 @@
|
||||
---
|
||||
name: everything-claude-code-conventions
|
||||
description: Development conventions and patterns for everything-claude-code. JavaScript project with conventional commits.
|
||||
---
|
||||
```markdown
|
||||
# everything-claude-code Development Patterns
|
||||
|
||||
# Everything Claude Code Conventions
|
||||
|
||||
> Generated from [affaan-m/everything-claude-code](https://github.com/affaan-m/everything-claude-code) on 2026-04-02
|
||||
> Auto-generated skill from repository analysis
|
||||
|
||||
## Overview
|
||||
|
||||
This skill teaches Claude the development patterns and conventions used in everything-claude-code.
|
||||
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.
|
||||
|
||||
## Tech Stack
|
||||
## Coding Conventions
|
||||
|
||||
- **Primary Language**: JavaScript
|
||||
- **Architecture**: hybrid module organization
|
||||
- **Test Location**: separate
|
||||
**Language:** JavaScript
|
||||
**Framework:** None detected
|
||||
|
||||
## When to Use This Skill
|
||||
### File Naming
|
||||
|
||||
Activate this skill when:
|
||||
- Making changes to this repository
|
||||
- Adding new features following established patterns
|
||||
- Writing tests that match project conventions
|
||||
- Creating commits with proper message format
|
||||
- Use **camelCase** for file names.
|
||||
- Example: `mySkillHandler.js`, `installTargetManager.js`
|
||||
|
||||
## Commit Conventions
|
||||
### Import Style
|
||||
|
||||
Follow these commit message conventions based on 500 analyzed commits.
|
||||
- Use **relative imports** for modules within the repository.
|
||||
- Example:
|
||||
```js
|
||||
const utils = require('./utils');
|
||||
import { runTest } from '../testHelpers';
|
||||
```
|
||||
|
||||
### Commit Style: Conventional Commits
|
||||
### Export Style
|
||||
|
||||
### Prefixes Used
|
||||
- **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() { ... }
|
||||
```
|
||||
|
||||
- `fix`
|
||||
- `feat`
|
||||
- `docs`
|
||||
- `chore`
|
||||
### Commit Messages
|
||||
|
||||
### Message Guidelines
|
||||
- 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
|
||||
```
|
||||
|
||||
- Average message length: ~57 characters
|
||||
- Keep first line concise and descriptive
|
||||
- Use imperative mood ("Add feature" not "Added feature")
|
||||
## Workflows
|
||||
|
||||
### Add New Skill
|
||||
**Trigger:** When introducing a new skill (capability, workflow, or integration) to the platform
|
||||
**Command:** `/add-skill`
|
||||
|
||||
*Commit message example*
|
||||
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`.
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code-conventions ECC bundle (.claude/commands/add-or-update-skill.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
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix: port safe ci cleanup from backlog
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
refactor: collapse legacy command bodies into skills
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
docs: close bundle drift and sync plugin guidance
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
chore: ignore local orchestration artifacts
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code-conventions ECC bundle (.claude/commands/refactoring.md)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code-conventions ECC bundle (.claude/commands/feature-development.md)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code-conventions ECC bundle (.claude/enterprise/controls.md)
|
||||
```
|
||||
|
||||
## Architecture
|
||||
|
||||
### Project Structure: Single Package
|
||||
|
||||
This project uses **hybrid** module organization.
|
||||
|
||||
### Configuration Files
|
||||
|
||||
- `.github/workflows/ci.yml`
|
||||
- `.github/workflows/maintenance.yml`
|
||||
- `.github/workflows/monthly-metrics.yml`
|
||||
- `.github/workflows/release.yml`
|
||||
- `.github/workflows/reusable-release.yml`
|
||||
- `.github/workflows/reusable-test.yml`
|
||||
- `.github/workflows/reusable-validate.yml`
|
||||
- `.opencode/package.json`
|
||||
- `.opencode/tsconfig.json`
|
||||
- `.prettierrc`
|
||||
- `eslint.config.js`
|
||||
- `package.json`
|
||||
|
||||
### Guidelines
|
||||
|
||||
- This project uses a hybrid organization
|
||||
- Follow existing patterns when adding new code
|
||||
|
||||
## Code Style
|
||||
|
||||
### Language: JavaScript
|
||||
|
||||
### Naming Conventions
|
||||
|
||||
| Element | Convention |
|
||||
|---------|------------|
|
||||
| Files | camelCase |
|
||||
| Functions | camelCase |
|
||||
| Classes | PascalCase |
|
||||
| Constants | SCREAMING_SNAKE_CASE |
|
||||
|
||||
### Import Style: Relative Imports
|
||||
|
||||
### Export Style: Mixed Style
|
||||
|
||||
|
||||
*Preferred import style*
|
||||
|
||||
```typescript
|
||||
// Use relative imports
|
||||
import { Button } from '../components/Button'
|
||||
import { useAuth } from './hooks/useAuth'
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
### Test Framework
|
||||
|
||||
No specific test framework detected — use the repository's existing test patterns.
|
||||
|
||||
### File Pattern: `*.test.js`
|
||||
|
||||
### Test Types
|
||||
|
||||
- **Unit tests**: Test individual functions and components in isolation
|
||||
- **Integration tests**: Test interactions between multiple components/services
|
||||
|
||||
### Coverage
|
||||
|
||||
This project has coverage reporting configured. Aim for 80%+ coverage.
|
||||
|
||||
|
||||
## Error Handling
|
||||
|
||||
### Error Handling Style: Try-Catch Blocks
|
||||
|
||||
|
||||
*Standard error handling pattern*
|
||||
|
||||
```typescript
|
||||
try {
|
||||
const result = await riskyOperation()
|
||||
return result
|
||||
} catch (error) {
|
||||
console.error('Operation failed:', error)
|
||||
throw new Error('User-friendly message')
|
||||
}
|
||||
```
|
||||
|
||||
## Common Workflows
|
||||
|
||||
These workflows were detected from analyzing commit patterns.
|
||||
|
||||
### Feature Development
|
||||
|
||||
Standard feature implementation workflow
|
||||
|
||||
**Frequency**: ~19 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add feature implementation
|
||||
2. Add tests for feature
|
||||
3. Update documentation
|
||||
|
||||
**Files typically involved**:
|
||||
- `.opencode/*`
|
||||
- `.opencode/plugins/*`
|
||||
- `.opencode/plugins/lib/*`
|
||||
- `**/*.test.*`
|
||||
- `**/api/**`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
feat(agents,skills): add opensource-pipeline — 3-agent workflow for safe public releases (#1036)
|
||||
feat(install): add CodeBuddy(Tencent) adaptation with installation scripts (#1038)
|
||||
chore(deps-dev): bump c8 from 10.1.3 to 11.0.0 (#1065)
|
||||
```
|
||||
|
||||
### Refactoring
|
||||
|
||||
Code refactoring and cleanup workflow
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Ensure tests pass before refactor
|
||||
2. Refactor code structure
|
||||
3. Verify tests still pass
|
||||
|
||||
**Files typically involved**:
|
||||
- `src/**/*`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
refactor: collapse legacy command bodies into skills
|
||||
feat: add connected operator workflow skills
|
||||
feat: expand lead intelligence outreach channels
|
||||
```
|
||||
|
||||
### Add Or Update Skill
|
||||
|
||||
Adds or updates a skill module, including documentation and references, and registers it in manifests and documentation.
|
||||
|
||||
**Frequency**: ~4 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or update SKILL.md in skills/<skill-name>/ or .agents/skills/<skill-name>/
|
||||
2. Optionally add or update references or assets under skills/<skill-name>/references/ or assets/
|
||||
3. Update manifests/install-modules.json and/or manifests/install-components.json
|
||||
4. Update AGENTS.md, README.md, README.zh-CN.md, and docs/zh-CN/* as needed
|
||||
5. Update WORKING-CONTEXT.md if context changes
|
||||
6. Optionally update or create related test files
|
||||
|
||||
**Files typically involved**:
|
||||
- `skills/*/SKILL.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `skills/*/references/*.md`
|
||||
- `skills/*/assets/*`
|
||||
- `manifests/install-modules.json`
|
||||
- `manifests/install-components.json`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
- `docs/zh-CN/README.md`
|
||||
- `WORKING-CONTEXT.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or update SKILL.md in skills/<skill-name>/ or .agents/skills/<skill-name>/
|
||||
Optionally add or update references or assets under skills/<skill-name>/references/ or assets/
|
||||
Update manifests/install-modules.json and/or manifests/install-components.json
|
||||
Update AGENTS.md, README.md, README.zh-CN.md, and docs/zh-CN/* as needed
|
||||
Update WORKING-CONTEXT.md if context changes
|
||||
Optionally update or create related test files
|
||||
```
|
||||
|
||||
### Add Or Update Command Workflow
|
||||
|
||||
Adds or updates command documentation and workflow scripts for agentic or PRP workflows.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or update command markdown files under commands/ (e.g., prp-prd.md, code-review.md)
|
||||
2. If extending, update related commands (e.g., plan.md cross-references prp-plan.md)
|
||||
3. Address review feedback and iterate on command logic and documentation
|
||||
|
||||
**Files typically involved**:
|
||||
- `commands/*.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or update command markdown files under commands/ (e.g., prp-prd.md, code-review.md)
|
||||
If extending, update related commands (e.g., plan.md cross-references prp-plan.md)
|
||||
Address review feedback and iterate on command logic and documentation
|
||||
```
|
||||
|
||||
### Add Or Update Agent Or Agent Prompt
|
||||
|
||||
Adds or updates agent configuration, prompt files, and registers agents in orchestration manifests.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or update agent prompt files under .opencode/prompts/agents/
|
||||
2. Update .opencode/opencode.json to register or modify agent configuration
|
||||
3. Update AGENTS.md to document the new or updated agent
|
||||
|
||||
**Files typically involved**:
|
||||
- `.opencode/prompts/agents/*.txt`
|
||||
- `.opencode/opencode.json`
|
||||
- `AGENTS.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or update agent prompt files under .opencode/prompts/agents/
|
||||
Update .opencode/opencode.json to register or modify agent configuration
|
||||
Update AGENTS.md to document the new or updated agent
|
||||
```
|
||||
|
||||
### Feature Development Skill And Docs
|
||||
|
||||
Implements a new feature or workflow by adding skills, updating documentation, and synchronizing manifests and context.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add or update SKILL.md and related files in skills/ or .agents/skills/
|
||||
2. Update or create supporting documentation (README.md, AGENTS.md, docs/zh-CN/*, WORKING-CONTEXT.md)
|
||||
3. Update manifests/install-modules.json and/or manifests/install-components.json
|
||||
4. Synchronize or update related scripts or test files
|
||||
|
||||
**Files typically involved**:
|
||||
- `skills/*/SKILL.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
- `docs/zh-CN/README.md`
|
||||
- `WORKING-CONTEXT.md`
|
||||
- `manifests/install-modules.json`
|
||||
- `manifests/install-components.json`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Add or update SKILL.md and related files in skills/ or .agents/skills/
|
||||
Update or create supporting documentation (README.md, AGENTS.md, docs/zh-CN/*, WORKING-CONTEXT.md)
|
||||
Update manifests/install-modules.json and/or manifests/install-components.json
|
||||
Synchronize or update related scripts or test files
|
||||
```
|
||||
|
||||
### Refactor Or Sync Manifests And Context
|
||||
|
||||
Refactors commands, skills, or agents and synchronizes manifests and working context documentation.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Update or remove command files under commands/
|
||||
2. Update or create SKILL.md files as needed
|
||||
3. Update manifests/install-modules.json and/or install-components.json
|
||||
4. Update AGENTS.md, README.md, README.zh-CN.md, docs/zh-CN/*, WORKING-CONTEXT.md
|
||||
|
||||
**Files typically involved**:
|
||||
- `commands/*.md`
|
||||
- `skills/*/SKILL.md`
|
||||
- `manifests/install-modules.json`
|
||||
- `manifests/install-components.json`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
- `docs/zh-CN/README.md`
|
||||
- `WORKING-CONTEXT.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Update or remove command files under commands/
|
||||
Update or create SKILL.md files as needed
|
||||
Update manifests/install-modules.json and/or install-components.json
|
||||
Update AGENTS.md, README.md, README.zh-CN.md, docs/zh-CN/*, WORKING-CONTEXT.md
|
||||
```
|
||||
|
||||
### Add Or Update Install Target
|
||||
|
||||
Adds or updates an install target (e.g., CodeBuddy, Gemini) with scripts, schemas, and manifest registration.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add or update install/uninstall scripts under .<target>/
|
||||
2. Update or create README files for the target
|
||||
3. Update schemas (ecc-install-config.schema.json, install-modules.schema.json)
|
||||
4. Update scripts/lib/install-targets/<target>-project.js and registry.js
|
||||
5. Update manifests/install-modules.json
|
||||
6. Update or add related test files
|
||||
|
||||
**Files typically involved**:
|
||||
- `.<target>/*`
|
||||
- `manifests/install-modules.json`
|
||||
- `schemas/ecc-install-config.schema.json`
|
||||
- `schemas/install-modules.schema.json`
|
||||
- `scripts/lib/install-manifests.js`
|
||||
- `scripts/lib/install-targets/<target>-project.js`
|
||||
- `scripts/lib/install-targets/registry.js`
|
||||
- `tests/lib/install-targets.test.js`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Add or update install/uninstall scripts under .<target>/
|
||||
Update or create README files for the target
|
||||
Update schemas (ecc-install-config.schema.json, install-modules.schema.json)
|
||||
Update scripts/lib/install-targets/<target>-project.js and registry.js
|
||||
Update manifests/install-modules.json
|
||||
Update or add related test files
|
||||
```
|
||||
|
||||
|
||||
## Best Practices
|
||||
|
||||
Based on analysis of the codebase, follow these practices:
|
||||
|
||||
### Do
|
||||
|
||||
- Use conventional commit format (feat:, fix:, etc.)
|
||||
- Follow *.test.js naming pattern
|
||||
- Use camelCase for file names
|
||||
- Prefer mixed exports
|
||||
|
||||
### Don't
|
||||
|
||||
- Don't write vague commit messages
|
||||
- Don't skip tests for new features
|
||||
- Don't deviate from established patterns without discussion
|
||||
|
||||
---
|
||||
|
||||
*This skill was auto-generated by [ECC Tools](https://ecc.tools). Review and customize as needed for your team.*
|
||||
### 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)
|
||||
**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
|
||||
...
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add New Install Target or Adapter
|
||||
**Trigger:** When supporting a new install target (platform, IDE, or agent runtime)
|
||||
**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.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
mkdir .codebuddy
|
||||
touch .codebuddy/README.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 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, 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"]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 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
|
||||
**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 |
|
||||
```
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
"commandFiles": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-or-update-skill.md"
|
||||
".claude/commands/add-new-skill.md"
|
||||
],
|
||||
"updatedAt": "2026-04-02T03:14:01.196Z"
|
||||
"updatedAt": "2026-04-02T03:20:59.009Z"
|
||||
}
|
||||
Reference in New Issue
Block a user