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,422 +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: ~56 characters
|
||||
- Keep first line concise and descriptive
|
||||
- Use imperative mood ("Add feature" not "Added feature")
|
||||
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat(skills): add argus-design-review — three-tier design doc review
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix(tests): add USERPROFILE to repair.test.js for Windows
|
||||
```
|
||||
|
||||
*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
|
||||
fix(lint): add missing trailing newlines to remotion rules
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix(tests): normalize path separators in CLAUDE_PLUGIN_ROOT test
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix(ci): resolve markdownlint errors and Windows install-apply test
|
||||
```
|
||||
|
||||
## 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**: ~16 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(team-builder): use `claude agents` command for agent discovery (#1021)
|
||||
fix: extract inline SessionStart bootstrap to separate file (#1035)
|
||||
feat: add hexagonal architecture SKILL. (#1034)
|
||||
```
|
||||
|
||||
### Refactoring
|
||||
|
||||
Code refactoring and cleanup workflow
|
||||
|
||||
**Frequency**: ~2 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
|
||||
```
|
||||
## Workflows
|
||||
|
||||
### Add New Skill
|
||||
**Trigger:** When introducing a new skill (capability, workflow, or integration) to the platform
|
||||
**Command:** `/add-skill`
|
||||
|
||||
Adds a new skill to the system, including documentation and registration in summary/index files.
|
||||
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`.
|
||||
|
||||
**Frequency**: ~6 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create a new SKILL.md file under skills/{skill-name}/
|
||||
2. Optionally add reference files or assets under skills/{skill-name}/references/ or assets/
|
||||
3. Update AGENTS.md and README.md to document the new skill
|
||||
4. Update docs/zh-CN/AGENTS.md and docs/zh-CN/README.md for Chinese documentation
|
||||
5. Optionally update manifests/install-components.json or install-modules.json if the skill is installable
|
||||
|
||||
**Files typically involved**:
|
||||
- `skills/*/SKILL.md`
|
||||
- `skills/*/references/*.md`
|
||||
- `skills/*/assets/*`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
- `docs/zh-CN/README.md`
|
||||
- `manifests/install-components.json`
|
||||
- `manifests/install-modules.json`
|
||||
|
||||
**Example commit sequence**:
|
||||
**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
|
||||
```
|
||||
Create a new SKILL.md file under skills/{skill-name}/
|
||||
Optionally add reference files or assets under skills/{skill-name}/references/ or assets/
|
||||
Update AGENTS.md and README.md to document the new skill
|
||||
Update docs/zh-CN/AGENTS.md and docs/zh-CN/README.md for Chinese documentation
|
||||
Optionally update manifests/install-components.json or install-modules.json if the skill is installable
|
||||
```
|
||||
|
||||
### Add Or Update Command Workflow
|
||||
|
||||
Adds or updates a command file describing a workflow, often for agent orchestration or developer automation.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or modify a Markdown file under commands/ (e.g., commands/prp-*.md, commands/gan-*.md, commands/santa-loop.md)
|
||||
2. Document the workflow with YAML frontmatter, usage, and output sections
|
||||
3. Optionally update AGENTS.md, README.md, or other summary files if the command is significant
|
||||
4. Address review feedback and iterate on the command file
|
||||
|
||||
**Files typically involved**:
|
||||
- `commands/*.md`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or modify a Markdown file under commands/ (e.g., commands/prp-*.md, commands/gan-*.md, commands/santa-loop.md)
|
||||
Document the workflow with YAML frontmatter, usage, and output sections
|
||||
Optionally update AGENTS.md, README.md, or other summary files if the command is significant
|
||||
Address review feedback and iterate on the command file
|
||||
```
|
||||
|
||||
### Add Or Update Agent Definition
|
||||
|
||||
Adds or updates agent definition files to introduce or modify agent behaviors or roles.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or modify agent definition Markdown files under agents/
|
||||
2. Optionally update AGENTS.md to reflect new or changed agents
|
||||
3. Update skills or commands that reference the agent if necessary
|
||||
|
||||
**Files typically involved**:
|
||||
- `agents/*.md`
|
||||
- `AGENTS.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or modify agent definition Markdown files under agents/
|
||||
Optionally update AGENTS.md to reflect new or changed agents
|
||||
Update skills or commands that reference the agent if necessary
|
||||
```
|
||||
|
||||
### Add Install Target Or Adapter
|
||||
|
||||
Adds a new install target (integration with external tools/platforms) including schema, scripts, and tests.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create a new directory under .{target}/ with README and install/uninstall scripts
|
||||
2. Add or update scripts/lib/install-targets/{target}-project.js
|
||||
3. Update manifests/install-modules.json and schemas/ecc-install-config.schema.json
|
||||
4. Update registry.js and install-manifests.js as needed
|
||||
5. Add or update tests for the new install target
|
||||
|
||||
**Files typically involved**:
|
||||
- `.*/README.md`
|
||||
- `.*/install.*`
|
||||
- `.*/uninstall.*`
|
||||
- `scripts/lib/install-targets/*.js`
|
||||
- `manifests/install-modules.json`
|
||||
- `schemas/ecc-install-config.schema.json`
|
||||
- `schemas/install-modules.schema.json`
|
||||
- `scripts/lib/install-manifests.js`
|
||||
- `scripts/lib/install-targets/registry.js`
|
||||
- `tests/lib/install-targets.test.js`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create a new directory under .{target}/ with README and install/uninstall scripts
|
||||
Add or update scripts/lib/install-targets/{target}-project.js
|
||||
Update manifests/install-modules.json and schemas/ecc-install-config.schema.json
|
||||
Update registry.js and install-manifests.js as needed
|
||||
Add or update tests for the new install target
|
||||
```
|
||||
|
||||
### Test Fix Or Portability Fix
|
||||
|
||||
Fixes or improves test scripts, especially for cross-platform (Windows/Linux) compatibility.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit test files under tests/scripts/ or tests/lib/
|
||||
2. Normalize environment variables or path separators for Windows compatibility
|
||||
3. Update related implementation files if needed (e.g., scripts/lib/install/apply.js)
|
||||
4. Commit with a fix(tests): or fix(ci): message
|
||||
|
||||
**Files typically involved**:
|
||||
- `tests/scripts/*.test.js`
|
||||
- `tests/lib/*.test.js`
|
||||
- `scripts/lib/install/*.js`
|
||||
- `scripts/lib/install-manifests.js`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit test files under tests/scripts/ or tests/lib/
|
||||
Normalize environment variables or path separators for Windows compatibility
|
||||
Update related implementation files if needed (e.g., scripts/lib/install/apply.js)
|
||||
Commit with a fix(tests): or fix(ci): message
|
||||
```
|
||||
|
||||
### Update Repo Documentation And Guidance
|
||||
|
||||
Updates documentation files to reflect new workflows, skills, or repo guidance.
|
||||
|
||||
**Frequency**: ~4 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit README.md, README.zh-CN.md, WORKING-CONTEXT.md, AGENTS.md, or the-shortform-guide.md
|
||||
2. Edit docs/zh-CN/* as needed for Chinese documentation
|
||||
3. Optionally update .claude-plugin/README.md, .codex-plugin/README.md, or related plugin docs
|
||||
|
||||
**Files typically involved**:
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `WORKING-CONTEXT.md`
|
||||
- `AGENTS.md`
|
||||
- `the-shortform-guide.md`
|
||||
- `docs/zh-CN/*.md`
|
||||
- `.claude-plugin/README.md`
|
||||
- `.codex-plugin/README.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit README.md, README.zh-CN.md, WORKING-CONTEXT.md, AGENTS.md, or the-shortform-guide.md
|
||||
Edit docs/zh-CN/* as needed for Chinese documentation
|
||||
Optionally update .claude-plugin/README.md, .codex-plugin/README.md, or related plugin docs
|
||||
```
|
||||
|
||||
|
||||
## 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 |
|
||||
```
|
||||
|
||||
@@ -10,16 +10,16 @@ Use this workflow when working on **add-new-skill** in `everything-claude-code`.
|
||||
|
||||
## Goal
|
||||
|
||||
Adds a new skill to the system, including documentation and registration in summary/index files.
|
||||
Adds a new skill to the system, including documentation and sometimes references/assets.
|
||||
|
||||
## Common Files
|
||||
|
||||
- `skills/*/SKILL.md`
|
||||
- `skills/*/references/*.md`
|
||||
- `skills/*/assets/*`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
|
||||
## Suggested Sequence
|
||||
|
||||
@@ -30,11 +30,10 @@ Adds a new skill to the system, including documentation and registration in summ
|
||||
|
||||
## Typical Commit Signals
|
||||
|
||||
- Create a new SKILL.md file under skills/{skill-name}/
|
||||
- Optionally add reference files or assets under skills/{skill-name}/references/ or assets/
|
||||
- Update AGENTS.md and README.md to document the new skill
|
||||
- Update docs/zh-CN/AGENTS.md and docs/zh-CN/README.md for Chinese documentation
|
||||
- Optionally update manifests/install-components.json or install-modules.json if the skill is installable
|
||||
- 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
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
"version": "1.3",
|
||||
"schemaVersion": "1.0",
|
||||
"generatedBy": "ecc-tools",
|
||||
"generatedAt": "2026-04-02T03:25:20.900Z",
|
||||
"generatedAt": "2026-04-02T03:20:59.009Z",
|
||||
"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:26:02.848Z"
|
||||
"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-new-skill: Adds a new skill to the system, including documentation and registration in summary/index files.
|
||||
- add-new-skill: Adds a new skill to the system, including documentation and sometimes references/assets.
|
||||
|
||||
## Review Reminder
|
||||
|
||||
|
||||
@@ -1,422 +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: ~56 characters
|
||||
- Keep first line concise and descriptive
|
||||
- Use imperative mood ("Add feature" not "Added feature")
|
||||
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat(skills): add argus-design-review — three-tier design doc review
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix(tests): add USERPROFILE to repair.test.js for Windows
|
||||
```
|
||||
|
||||
*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
|
||||
fix(lint): add missing trailing newlines to remotion rules
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix(tests): normalize path separators in CLAUDE_PLUGIN_ROOT test
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix(ci): resolve markdownlint errors and Windows install-apply test
|
||||
```
|
||||
|
||||
## 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**: ~16 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(team-builder): use `claude agents` command for agent discovery (#1021)
|
||||
fix: extract inline SessionStart bootstrap to separate file (#1035)
|
||||
feat: add hexagonal architecture SKILL. (#1034)
|
||||
```
|
||||
|
||||
### Refactoring
|
||||
|
||||
Code refactoring and cleanup workflow
|
||||
|
||||
**Frequency**: ~2 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
|
||||
```
|
||||
## Workflows
|
||||
|
||||
### Add New Skill
|
||||
**Trigger:** When introducing a new skill (capability, workflow, or integration) to the platform
|
||||
**Command:** `/add-skill`
|
||||
|
||||
Adds a new skill to the system, including documentation and registration in summary/index files.
|
||||
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`.
|
||||
|
||||
**Frequency**: ~6 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create a new SKILL.md file under skills/{skill-name}/
|
||||
2. Optionally add reference files or assets under skills/{skill-name}/references/ or assets/
|
||||
3. Update AGENTS.md and README.md to document the new skill
|
||||
4. Update docs/zh-CN/AGENTS.md and docs/zh-CN/README.md for Chinese documentation
|
||||
5. Optionally update manifests/install-components.json or install-modules.json if the skill is installable
|
||||
|
||||
**Files typically involved**:
|
||||
- `skills/*/SKILL.md`
|
||||
- `skills/*/references/*.md`
|
||||
- `skills/*/assets/*`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
- `docs/zh-CN/README.md`
|
||||
- `manifests/install-components.json`
|
||||
- `manifests/install-modules.json`
|
||||
|
||||
**Example commit sequence**:
|
||||
**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
|
||||
```
|
||||
Create a new SKILL.md file under skills/{skill-name}/
|
||||
Optionally add reference files or assets under skills/{skill-name}/references/ or assets/
|
||||
Update AGENTS.md and README.md to document the new skill
|
||||
Update docs/zh-CN/AGENTS.md and docs/zh-CN/README.md for Chinese documentation
|
||||
Optionally update manifests/install-components.json or install-modules.json if the skill is installable
|
||||
```
|
||||
|
||||
### Add Or Update Command Workflow
|
||||
|
||||
Adds or updates a command file describing a workflow, often for agent orchestration or developer automation.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or modify a Markdown file under commands/ (e.g., commands/prp-*.md, commands/gan-*.md, commands/santa-loop.md)
|
||||
2. Document the workflow with YAML frontmatter, usage, and output sections
|
||||
3. Optionally update AGENTS.md, README.md, or other summary files if the command is significant
|
||||
4. Address review feedback and iterate on the command file
|
||||
|
||||
**Files typically involved**:
|
||||
- `commands/*.md`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or modify a Markdown file under commands/ (e.g., commands/prp-*.md, commands/gan-*.md, commands/santa-loop.md)
|
||||
Document the workflow with YAML frontmatter, usage, and output sections
|
||||
Optionally update AGENTS.md, README.md, or other summary files if the command is significant
|
||||
Address review feedback and iterate on the command file
|
||||
```
|
||||
|
||||
### Add Or Update Agent Definition
|
||||
|
||||
Adds or updates agent definition files to introduce or modify agent behaviors or roles.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or modify agent definition Markdown files under agents/
|
||||
2. Optionally update AGENTS.md to reflect new or changed agents
|
||||
3. Update skills or commands that reference the agent if necessary
|
||||
|
||||
**Files typically involved**:
|
||||
- `agents/*.md`
|
||||
- `AGENTS.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or modify agent definition Markdown files under agents/
|
||||
Optionally update AGENTS.md to reflect new or changed agents
|
||||
Update skills or commands that reference the agent if necessary
|
||||
```
|
||||
|
||||
### Add Install Target Or Adapter
|
||||
|
||||
Adds a new install target (integration with external tools/platforms) including schema, scripts, and tests.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create a new directory under .{target}/ with README and install/uninstall scripts
|
||||
2. Add or update scripts/lib/install-targets/{target}-project.js
|
||||
3. Update manifests/install-modules.json and schemas/ecc-install-config.schema.json
|
||||
4. Update registry.js and install-manifests.js as needed
|
||||
5. Add or update tests for the new install target
|
||||
|
||||
**Files typically involved**:
|
||||
- `.*/README.md`
|
||||
- `.*/install.*`
|
||||
- `.*/uninstall.*`
|
||||
- `scripts/lib/install-targets/*.js`
|
||||
- `manifests/install-modules.json`
|
||||
- `schemas/ecc-install-config.schema.json`
|
||||
- `schemas/install-modules.schema.json`
|
||||
- `scripts/lib/install-manifests.js`
|
||||
- `scripts/lib/install-targets/registry.js`
|
||||
- `tests/lib/install-targets.test.js`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create a new directory under .{target}/ with README and install/uninstall scripts
|
||||
Add or update scripts/lib/install-targets/{target}-project.js
|
||||
Update manifests/install-modules.json and schemas/ecc-install-config.schema.json
|
||||
Update registry.js and install-manifests.js as needed
|
||||
Add or update tests for the new install target
|
||||
```
|
||||
|
||||
### Test Fix Or Portability Fix
|
||||
|
||||
Fixes or improves test scripts, especially for cross-platform (Windows/Linux) compatibility.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit test files under tests/scripts/ or tests/lib/
|
||||
2. Normalize environment variables or path separators for Windows compatibility
|
||||
3. Update related implementation files if needed (e.g., scripts/lib/install/apply.js)
|
||||
4. Commit with a fix(tests): or fix(ci): message
|
||||
|
||||
**Files typically involved**:
|
||||
- `tests/scripts/*.test.js`
|
||||
- `tests/lib/*.test.js`
|
||||
- `scripts/lib/install/*.js`
|
||||
- `scripts/lib/install-manifests.js`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit test files under tests/scripts/ or tests/lib/
|
||||
Normalize environment variables or path separators for Windows compatibility
|
||||
Update related implementation files if needed (e.g., scripts/lib/install/apply.js)
|
||||
Commit with a fix(tests): or fix(ci): message
|
||||
```
|
||||
|
||||
### Update Repo Documentation And Guidance
|
||||
|
||||
Updates documentation files to reflect new workflows, skills, or repo guidance.
|
||||
|
||||
**Frequency**: ~4 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit README.md, README.zh-CN.md, WORKING-CONTEXT.md, AGENTS.md, or the-shortform-guide.md
|
||||
2. Edit docs/zh-CN/* as needed for Chinese documentation
|
||||
3. Optionally update .claude-plugin/README.md, .codex-plugin/README.md, or related plugin docs
|
||||
|
||||
**Files typically involved**:
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `WORKING-CONTEXT.md`
|
||||
- `AGENTS.md`
|
||||
- `the-shortform-guide.md`
|
||||
- `docs/zh-CN/*.md`
|
||||
- `.claude-plugin/README.md`
|
||||
- `.codex-plugin/README.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit README.md, README.zh-CN.md, WORKING-CONTEXT.md, AGENTS.md, or the-shortform-guide.md
|
||||
Edit docs/zh-CN/* as needed for Chinese documentation
|
||||
Optionally update .claude-plugin/README.md, .codex-plugin/README.md, or related plugin docs
|
||||
```
|
||||
|
||||
|
||||
## 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 |
|
||||
```
|
||||
|
||||
@@ -11,5 +11,5 @@
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-new-skill.md"
|
||||
],
|
||||
"updatedAt": "2026-04-02T03:25:20.900Z"
|
||||
"updatedAt": "2026-04-02T03:20:59.009Z"
|
||||
}
|
||||
Reference in New Issue
Block a user