mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-04-02 23:23:31 +08:00
Compare commits
15 Commits
ecc-tools/
...
ecc-tools/
| Author | SHA1 | Date | |
|---|---|---|---|
|
2200582b18 | ||
|
|
2e645ca04f | ||
|
|
73df5a0180 | ||
|
|
838464fa2f | ||
|
|
a667b2124b | ||
|
|
bf45d3cbc1 | ||
|
|
afd2a031cb | ||
|
|
d4cdcc5de7 | ||
|
|
2ac04c6a8e | ||
|
|
7c8af2537e | ||
|
|
6d1b5cbe89 | ||
|
|
33caa95137 | ||
|
|
a317a60950 | ||
|
|
05f745dd8c | ||
|
|
2c33c90c76 |
@@ -1,452 +1,165 @@
|
||||
---
|
||||
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 provides a comprehensive guide to the development patterns, coding conventions, and key workflows used in the `everything-claude-code` repository. The project is written in JavaScript (no framework detected) and focuses on modular skill development, extensible command workflows, and robust automation for agents and integrations. This guide will help contributors maintain consistency and efficiency across code, documentation, and automation.
|
||||
|
||||
## Tech Stack
|
||||
## Coding Conventions
|
||||
|
||||
- **Primary Language**: JavaScript
|
||||
- **Architecture**: hybrid module organization
|
||||
- **Test Location**: separate
|
||||
**File Naming**
|
||||
- Use `camelCase` for JavaScript files and directories.
|
||||
- Example: `installTargets.js`, `mySkillHandler.js`
|
||||
|
||||
## When to Use This Skill
|
||||
**Import Style**
|
||||
- Use relative imports for modules within the repository.
|
||||
- Example:
|
||||
```js
|
||||
import myUtil from '../utils/myUtil.js';
|
||||
```
|
||||
|
||||
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
|
||||
**Export Style**
|
||||
- Mixed: Both default and named exports are used.
|
||||
- Example (default export):
|
||||
```js
|
||||
export default function installTarget() { ... }
|
||||
```
|
||||
- Example (named export):
|
||||
```js
|
||||
export function registerSkill() { ... }
|
||||
```
|
||||
|
||||
## Commit Conventions
|
||||
**Commit Messages**
|
||||
- Use [Conventional Commits](https://www.conventionalcommits.org/) with these prefixes: `fix`, `feat`, `docs`, `chore`.
|
||||
- Example: `feat: add support for new install target (CodeBuddy)`
|
||||
|
||||
Follow these commit message conventions based on 500 analyzed commits.
|
||||
## Workflows
|
||||
|
||||
### Commit Style: Conventional Commits
|
||||
### Add or Update a Skill
|
||||
**Trigger:** When introducing a new skill or updating an existing skill's capabilities or documentation
|
||||
**Command:** `/add-skill`
|
||||
|
||||
### Prefixes Used
|
||||
1. Create or update `SKILL.md` in `skills/<skill-name>/` or `.agents/skills/<skill-name>/`.
|
||||
2. Optionally add or update related reference files (e.g., assets, rules, schemas) in the skill directory.
|
||||
3. Update `manifests/install-modules.json` and/or `manifests/install-components.json` to register the new skill.
|
||||
4. Update documentation files: `AGENTS.md`, `README.md`, `README.zh-CN.md`, `docs/zh-CN/AGENTS.md`, and `docs/zh-CN/README.md`.
|
||||
5. Optionally add or update tests for the skill.
|
||||
|
||||
- `fix`
|
||||
- `feat`
|
||||
- `docs`
|
||||
- `chore`
|
||||
|
||||
### Message Guidelines
|
||||
|
||||
- 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-dispatch — multi-model task dispatcher
|
||||
**Example:**
|
||||
```bash
|
||||
# Add a new skill
|
||||
mkdir skills/myNewSkill
|
||||
touch skills/myNewSkill/SKILL.md
|
||||
# Update manifests
|
||||
vim manifests/install-modules.json
|
||||
# Document the skill
|
||||
vim README.md AGENTS.md
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
refactor: extract social graph ranking core
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix: port safe ci cleanup from backlog
|
||||
```
|
||||
|
||||
*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(skills): add brand voice and network ops lanes
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: sync the codex baseline and agent roles
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix: harden install and codex sync portability
|
||||
```
|
||||
|
||||
## 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**: ~14 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**: ~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 New Skill
|
||||
|
||||
Adds a new AI agent skill to the codebase, including documentation and registration.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create a new SKILL.md file in skills/<skill-name>/ or .agents/skills/<skill-name>/
|
||||
2. Optionally add supporting scripts or references under the skill directory
|
||||
3. Update AGENTS.md and/or README.md to document the new skill
|
||||
4. Update docs/zh-CN/AGENTS.md and docs/zh-CN/README.md for Chinese documentation
|
||||
5. Update manifests/install-modules.json or install-components.json to register the skill
|
||||
|
||||
**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`
|
||||
- `manifests/install-modules.json`
|
||||
- `manifests/install-components.json`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create a new SKILL.md file in skills/<skill-name>/ or .agents/skills/<skill-name>/
|
||||
Optionally add supporting scripts or references under the skill directory
|
||||
Update AGENTS.md and/or README.md to document the new skill
|
||||
Update docs/zh-CN/AGENTS.md and docs/zh-CN/README.md for Chinese documentation
|
||||
Update manifests/install-modules.json or install-components.json to register the skill
|
||||
```
|
||||
|
||||
### Add New Agent Or Pipeline
|
||||
|
||||
Adds a new agent or multi-agent workflow pipeline, including agent definitions and orchestration skills.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create one or more agent definition files in agents/
|
||||
2. Create or update a SKILL.md in skills/<pipeline-name>/ to orchestrate or document the workflow
|
||||
3. Optionally add supporting commands, scripts, or examples
|
||||
4. Update AGENTS.md and/or README.md to document the new pipeline
|
||||
|
||||
**Files typically involved**:
|
||||
- `agents/*.md`
|
||||
- `skills/*/SKILL.md`
|
||||
- `commands/*.md`
|
||||
- `scripts/*.sh`
|
||||
- `examples/*/README.md`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create one or more agent definition files in agents/
|
||||
Create or update a SKILL.md in skills/<pipeline-name>/ to orchestrate or document the workflow
|
||||
Optionally add supporting commands, scripts, or examples
|
||||
Update AGENTS.md and/or README.md to document the new pipeline
|
||||
```
|
||||
|
||||
### Add Or Update Command Workflow
|
||||
|
||||
Adds or extends a CLI command for agent workflows, often with review feedback iterations.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or update one or more command markdown files in commands/
|
||||
2. Iterate with fixes based on review feedback (improving YAML frontmatter, usage, output, etc.)
|
||||
3. Optionally update AGENTS.md or documentation to reference the new command
|
||||
|
||||
**Files typically involved**:
|
||||
- `commands/*.md`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or update one or more command markdown files in commands/
|
||||
Iterate with fixes based on review feedback (improving YAML frontmatter, usage, output, etc.)
|
||||
Optionally update AGENTS.md or documentation to reference the new command
|
||||
```
|
||||
|
||||
### Add Install Target Or Adapter
|
||||
|
||||
Adds support for a new install target (e.g., Gemini, CodeBuddy), including scripts, schemas, and manifest updates.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add a new directory for the install target (e.g., .gemini/, .codebuddy/)
|
||||
2. Add install/uninstall scripts and README(s)
|
||||
3. Update schemas/ecc-install-config.schema.json and/or install-modules.schema.json
|
||||
4. Update manifests/install-modules.json
|
||||
5. Update scripts/lib/install-manifests.js and scripts/lib/install-targets/<target>.js
|
||||
6. Add or update tests for the new install target
|
||||
|
||||
**Files typically involved**:
|
||||
- `.<target>/*`
|
||||
- `schemas/ecc-install-config.schema.json`
|
||||
- `schemas/install-modules.schema.json`
|
||||
- `manifests/install-modules.json`
|
||||
- `scripts/lib/install-manifests.js`
|
||||
- `scripts/lib/install-targets/*.js`
|
||||
- `tests/lib/install-targets.test.js`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Add a new directory for the install target (e.g., .gemini/, .codebuddy/)
|
||||
Add install/uninstall scripts and README(s)
|
||||
Update schemas/ecc-install-config.schema.json and/or install-modules.schema.json
|
||||
Update manifests/install-modules.json
|
||||
Update scripts/lib/install-manifests.js and scripts/lib/install-targets/<target>.js
|
||||
Add or update tests for the new install target
|
||||
```
|
||||
|
||||
### Update Hooks Or Automation
|
||||
|
||||
Refactors or fixes hooks and automation scripts for CI, formatting, or agent workflow integration.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit hooks/hooks.json to update hook configuration
|
||||
2. Edit or add scripts/hooks/*.js or scripts/hooks/*.sh for hook logic
|
||||
3. Update or add tests for the hooks in tests/hooks/*.test.js
|
||||
4. Optionally update related scripts or documentation
|
||||
|
||||
**Files typically involved**:
|
||||
- `hooks/hooks.json`
|
||||
- `scripts/hooks/*.js`
|
||||
- `scripts/hooks/*.sh`
|
||||
- `tests/hooks/*.test.js`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit hooks/hooks.json to update hook configuration
|
||||
Edit or add scripts/hooks/*.js or scripts/hooks/*.sh for hook logic
|
||||
Update or add tests for the hooks in tests/hooks/*.test.js
|
||||
Optionally update related scripts or documentation
|
||||
```
|
||||
|
||||
### Documentation Sync And Localization
|
||||
|
||||
Updates documentation and ensures Chinese and English docs are in sync, including AGENTS.md and README files.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit AGENTS.md, README.md, README.zh-CN.md
|
||||
2. Edit docs/zh-CN/AGENTS.md, docs/zh-CN/README.md
|
||||
3. Optionally update skills/*/SKILL.md and .agents/skills/*/SKILL.md for doc improvements
|
||||
4. Edit WORKING-CONTEXT.md or the-shortform-guide.md as needed
|
||||
|
||||
**Files typically involved**:
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
- `docs/zh-CN/README.md`
|
||||
- `skills/*/SKILL.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `WORKING-CONTEXT.md`
|
||||
- `the-shortform-guide.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit AGENTS.md, README.md, README.zh-CN.md
|
||||
Edit docs/zh-CN/AGENTS.md, docs/zh-CN/README.md
|
||||
Optionally update skills/*/SKILL.md and .agents/skills/*/SKILL.md for doc improvements
|
||||
Edit WORKING-CONTEXT.md or the-shortform-guide.md as needed
|
||||
```
|
||||
|
||||
### Dependency Or Ci Update
|
||||
|
||||
Updates dependencies or CI workflow files, often via automated bots like dependabot.
|
||||
|
||||
**Frequency**: ~4 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit .github/workflows/*.yml to update actions or workflow steps
|
||||
2. Edit package.json, yarn.lock, or package-lock.json for dependency updates
|
||||
3. Optionally update related scripts or lockfiles
|
||||
|
||||
**Files typically involved**:
|
||||
- `.github/workflows/*.yml`
|
||||
- `package.json`
|
||||
- `yarn.lock`
|
||||
- `package-lock.json`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit .github/workflows/*.yml to update actions or workflow steps
|
||||
Edit package.json, yarn.lock, or package-lock.json for dependency updates
|
||||
Optionally update related scripts or lockfiles
|
||||
```
|
||||
|
||||
|
||||
## 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 or Update a Command Workflow
|
||||
**Trigger:** When introducing or improving a command-driven workflow (e.g., PRP, code review, refactoring)
|
||||
**Command:** `/add-command`
|
||||
|
||||
1. Create or update a markdown file in `commands/` (e.g., `commands/prp-*.md`).
|
||||
2. If relevant, update or add supporting files in `.claude/commands/`.
|
||||
3. Optionally update documentation or references to the command in `README.md` or `AGENTS.md`.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
# Add a new PRP command workflow
|
||||
touch commands/prp-enhanced.md
|
||||
# Optionally update supporting files
|
||||
vim .claude/commands/prp-enhanced.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Refactor Skill or Core Logic
|
||||
**Trigger:** When improving, reorganizing, or merging existing skill or core logic for maintainability or performance
|
||||
**Command:** `/refactor-skill`
|
||||
|
||||
1. Edit multiple `SKILL.md` files in `skills/` or `.agents/skills/`.
|
||||
2. Update documentation: `AGENTS.md`, `README.md`, `README.zh-CN.md`, `docs/zh-CN/AGENTS.md`, `docs/zh-CN/README.md`.
|
||||
3. Update `manifests/install-modules.json` or related manifests as needed.
|
||||
4. Remove, merge, or rename legacy command or skill files.
|
||||
5. Optionally update or add tests for the refactored logic.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
# Refactor multiple skills
|
||||
vim skills/skillA/SKILL.md skills/skillB/SKILL.md
|
||||
# Update manifests and docs
|
||||
vim manifests/install-modules.json README.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update Install Target
|
||||
**Trigger:** When supporting a new external tool or environment as an install target
|
||||
**Command:** `/add-install-target`
|
||||
|
||||
1. Create or update install scripts in a dedicated directory (e.g., `.codebuddy/`, `.gemini/`).
|
||||
2. Add or update install target logic in `scripts/lib/install-targets/`.
|
||||
3. Update `manifests/install-modules.json` and `schemas/ecc-install-config.schema.json`.
|
||||
4. Update or add tests for the new install target in `tests/lib/install-targets.test.js`.
|
||||
5. Update registry logic if necessary.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
# Add a Gemini install target
|
||||
mkdir .gemini
|
||||
touch .gemini/install.sh
|
||||
vim scripts/lib/install-targets/gemini.js
|
||||
# Update schemas and manifests
|
||||
vim schemas/ecc-install-config.schema.json manifests/install-modules.json
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Update or Add CI/CD Workflow
|
||||
**Trigger:** When improving, fixing, or adding CI/CD automation (e.g., dependency updates, release validation)
|
||||
**Command:** `/update-ci`
|
||||
|
||||
1. Edit or add YAML files in `.github/workflows/`.
|
||||
2. Optionally update related scripts or lockfiles (`yarn.lock`, `package-lock.json`).
|
||||
3. Optionally update hooks or validation scripts.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
# Add a new CI workflow
|
||||
touch .github/workflows/dependency-check.yml
|
||||
# Update lockfiles if needed
|
||||
yarn install
|
||||
```
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
- **Test Files:** Use the `*.test.js` naming pattern.
|
||||
- Example: `installTargets.test.js`
|
||||
- **Framework:** Not explicitly specified; use standard Node.js or your preferred JS testing framework.
|
||||
- **Placement:** Tests are typically placed alongside implementation or in a `tests/` directory.
|
||||
|
||||
**Example Test File:**
|
||||
```js
|
||||
// tests/lib/install-targets.test.js
|
||||
import { installTarget } from '../../scripts/lib/install-targets/gemini.js';
|
||||
|
||||
test('should install Gemini target', () => {
|
||||
expect(installTarget()).toBe(true);
|
||||
});
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Purpose |
|
||||
|---------------------|--------------------------------------------------------------|
|
||||
| /add-skill | Add or update a skill, including documentation and manifests |
|
||||
| /add-command | Add or update a command workflow |
|
||||
| /refactor-skill | Refactor skill or core logic and update documentation |
|
||||
| /add-install-target | Add or update an install target integration |
|
||||
| /update-ci | Add or update CI/CD workflow files |
|
||||
```
|
||||
|
||||
@@ -1,42 +0,0 @@
|
||||
---
|
||||
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 AI agent skill to the codebase, including documentation and registration.
|
||||
|
||||
## 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 a new SKILL.md file in skills/<skill-name>/ or .agents/skills/<skill-name>/
|
||||
- Optionally add supporting scripts or references under the skill directory
|
||||
- Update AGENTS.md and/or README.md to document the new skill
|
||||
- Update docs/zh-CN/AGENTS.md and docs/zh-CN/README.md for Chinese documentation
|
||||
- Update manifests/install-modules.json or install-components.json to register the skill
|
||||
|
||||
## Notes
|
||||
|
||||
- Treat this as a scaffold, not a hard-coded script.
|
||||
- Update the command if the workflow evolves materially.
|
||||
42
.claude/commands/add-or-update-skill.md
Normal file
42
.claude/commands/add-or-update-skill.md
Normal file
@@ -0,0 +1,42 @@
|
||||
---
|
||||
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 a new skill or updates an existing skill in the system, including documentation and registration in manifests.
|
||||
|
||||
## Common Files
|
||||
|
||||
- `skills/*/SKILL.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `manifests/install-modules.json`
|
||||
- `manifests/install-components.json`
|
||||
- `AGENTS.md`
|
||||
- `README.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 SKILL.md in skills/<skill-name>/ or .agents/skills/<skill-name>/
|
||||
- Optionally add or update related reference files (e.g., assets, rules, schemas) in the skill directory
|
||||
- Update manifests/install-modules.json and/or manifests/install-components.json to register the new skill
|
||||
- Update AGENTS.md, README.md, README.zh-CN.md, docs/zh-CN/AGENTS.md, and docs/zh-CN/README.md to document the new skill
|
||||
- Optionally add or update tests for the skill
|
||||
|
||||
## 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-02T13:23:38.785Z",
|
||||
"generatedAt": "2026-04-02T13:44:44.593Z",
|
||||
"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-new-skill.md"
|
||||
".claude/commands/add-or-update-skill.md"
|
||||
],
|
||||
"packageFiles": {
|
||||
"runtime-core": [
|
||||
@@ -180,7 +180,7 @@
|
||||
"workflow-pack": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-new-skill.md"
|
||||
".claude/commands/add-or-update-skill.md"
|
||||
]
|
||||
},
|
||||
"moduleFiles": {
|
||||
@@ -211,7 +211,7 @@
|
||||
"workflow-pack": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-new-skill.md"
|
||||
".claude/commands/add-or-update-skill.md"
|
||||
]
|
||||
},
|
||||
"files": [
|
||||
@@ -297,8 +297,8 @@
|
||||
},
|
||||
{
|
||||
"moduleId": "workflow-pack",
|
||||
"path": ".claude/commands/add-new-skill.md",
|
||||
"description": "Workflow command scaffold for add-new-skill."
|
||||
"path": ".claude/commands/add-or-update-skill.md",
|
||||
"description": "Workflow command scaffold for add-or-update-skill."
|
||||
}
|
||||
],
|
||||
"workflows": [
|
||||
@@ -311,8 +311,8 @@
|
||||
"path": ".claude/commands/refactoring.md"
|
||||
},
|
||||
{
|
||||
"command": "add-new-skill",
|
||||
"path": ".claude/commands/add-new-skill.md"
|
||||
"command": "add-or-update-skill",
|
||||
"path": ".claude/commands/add-or-update-skill.md"
|
||||
}
|
||||
],
|
||||
"adapters": {
|
||||
@@ -322,7 +322,7 @@
|
||||
"commandPaths": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-new-skill.md"
|
||||
".claude/commands/add-or-update-skill.md"
|
||||
]
|
||||
},
|
||||
"codex": {
|
||||
|
||||
@@ -10,5 +10,5 @@
|
||||
"javascript"
|
||||
],
|
||||
"suggestedBy": "ecc-tools-repo-analysis",
|
||||
"createdAt": "2026-04-02T13:44:01.125Z"
|
||||
"createdAt": "2026-04-02T13:45:31.240Z"
|
||||
}
|
||||
@@ -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: 9
|
||||
- Workflows detected: 7
|
||||
@@ -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 AI agent skill to the codebase, including documentation and registration.
|
||||
- add-or-update-skill: Adds a new skill or updates an existing skill in the system, including documentation and registration in manifests.
|
||||
|
||||
## Review Reminder
|
||||
|
||||
|
||||
@@ -1,452 +1,165 @@
|
||||
---
|
||||
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 provides a comprehensive guide to the development patterns, coding conventions, and key workflows used in the `everything-claude-code` repository. The project is written in JavaScript (no framework detected) and focuses on modular skill development, extensible command workflows, and robust automation for agents and integrations. This guide will help contributors maintain consistency and efficiency across code, documentation, and automation.
|
||||
|
||||
## Tech Stack
|
||||
## Coding Conventions
|
||||
|
||||
- **Primary Language**: JavaScript
|
||||
- **Architecture**: hybrid module organization
|
||||
- **Test Location**: separate
|
||||
**File Naming**
|
||||
- Use `camelCase` for JavaScript files and directories.
|
||||
- Example: `installTargets.js`, `mySkillHandler.js`
|
||||
|
||||
## When to Use This Skill
|
||||
**Import Style**
|
||||
- Use relative imports for modules within the repository.
|
||||
- Example:
|
||||
```js
|
||||
import myUtil from '../utils/myUtil.js';
|
||||
```
|
||||
|
||||
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
|
||||
**Export Style**
|
||||
- Mixed: Both default and named exports are used.
|
||||
- Example (default export):
|
||||
```js
|
||||
export default function installTarget() { ... }
|
||||
```
|
||||
- Example (named export):
|
||||
```js
|
||||
export function registerSkill() { ... }
|
||||
```
|
||||
|
||||
## Commit Conventions
|
||||
**Commit Messages**
|
||||
- Use [Conventional Commits](https://www.conventionalcommits.org/) with these prefixes: `fix`, `feat`, `docs`, `chore`.
|
||||
- Example: `feat: add support for new install target (CodeBuddy)`
|
||||
|
||||
Follow these commit message conventions based on 500 analyzed commits.
|
||||
## Workflows
|
||||
|
||||
### Commit Style: Conventional Commits
|
||||
### Add or Update a Skill
|
||||
**Trigger:** When introducing a new skill or updating an existing skill's capabilities or documentation
|
||||
**Command:** `/add-skill`
|
||||
|
||||
### Prefixes Used
|
||||
1. Create or update `SKILL.md` in `skills/<skill-name>/` or `.agents/skills/<skill-name>/`.
|
||||
2. Optionally add or update related reference files (e.g., assets, rules, schemas) in the skill directory.
|
||||
3. Update `manifests/install-modules.json` and/or `manifests/install-components.json` to register the new skill.
|
||||
4. Update documentation files: `AGENTS.md`, `README.md`, `README.zh-CN.md`, `docs/zh-CN/AGENTS.md`, and `docs/zh-CN/README.md`.
|
||||
5. Optionally add or update tests for the skill.
|
||||
|
||||
- `fix`
|
||||
- `feat`
|
||||
- `docs`
|
||||
- `chore`
|
||||
|
||||
### Message Guidelines
|
||||
|
||||
- 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-dispatch — multi-model task dispatcher
|
||||
**Example:**
|
||||
```bash
|
||||
# Add a new skill
|
||||
mkdir skills/myNewSkill
|
||||
touch skills/myNewSkill/SKILL.md
|
||||
# Update manifests
|
||||
vim manifests/install-modules.json
|
||||
# Document the skill
|
||||
vim README.md AGENTS.md
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
refactor: extract social graph ranking core
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix: port safe ci cleanup from backlog
|
||||
```
|
||||
|
||||
*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(skills): add brand voice and network ops lanes
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: sync the codex baseline and agent roles
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix: harden install and codex sync portability
|
||||
```
|
||||
|
||||
## 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**: ~14 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**: ~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 New Skill
|
||||
|
||||
Adds a new AI agent skill to the codebase, including documentation and registration.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create a new SKILL.md file in skills/<skill-name>/ or .agents/skills/<skill-name>/
|
||||
2. Optionally add supporting scripts or references under the skill directory
|
||||
3. Update AGENTS.md and/or README.md to document the new skill
|
||||
4. Update docs/zh-CN/AGENTS.md and docs/zh-CN/README.md for Chinese documentation
|
||||
5. Update manifests/install-modules.json or install-components.json to register the skill
|
||||
|
||||
**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`
|
||||
- `manifests/install-modules.json`
|
||||
- `manifests/install-components.json`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create a new SKILL.md file in skills/<skill-name>/ or .agents/skills/<skill-name>/
|
||||
Optionally add supporting scripts or references under the skill directory
|
||||
Update AGENTS.md and/or README.md to document the new skill
|
||||
Update docs/zh-CN/AGENTS.md and docs/zh-CN/README.md for Chinese documentation
|
||||
Update manifests/install-modules.json or install-components.json to register the skill
|
||||
```
|
||||
|
||||
### Add New Agent Or Pipeline
|
||||
|
||||
Adds a new agent or multi-agent workflow pipeline, including agent definitions and orchestration skills.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create one or more agent definition files in agents/
|
||||
2. Create or update a SKILL.md in skills/<pipeline-name>/ to orchestrate or document the workflow
|
||||
3. Optionally add supporting commands, scripts, or examples
|
||||
4. Update AGENTS.md and/or README.md to document the new pipeline
|
||||
|
||||
**Files typically involved**:
|
||||
- `agents/*.md`
|
||||
- `skills/*/SKILL.md`
|
||||
- `commands/*.md`
|
||||
- `scripts/*.sh`
|
||||
- `examples/*/README.md`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create one or more agent definition files in agents/
|
||||
Create or update a SKILL.md in skills/<pipeline-name>/ to orchestrate or document the workflow
|
||||
Optionally add supporting commands, scripts, or examples
|
||||
Update AGENTS.md and/or README.md to document the new pipeline
|
||||
```
|
||||
|
||||
### Add Or Update Command Workflow
|
||||
|
||||
Adds or extends a CLI command for agent workflows, often with review feedback iterations.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or update one or more command markdown files in commands/
|
||||
2. Iterate with fixes based on review feedback (improving YAML frontmatter, usage, output, etc.)
|
||||
3. Optionally update AGENTS.md or documentation to reference the new command
|
||||
|
||||
**Files typically involved**:
|
||||
- `commands/*.md`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or update one or more command markdown files in commands/
|
||||
Iterate with fixes based on review feedback (improving YAML frontmatter, usage, output, etc.)
|
||||
Optionally update AGENTS.md or documentation to reference the new command
|
||||
```
|
||||
|
||||
### Add Install Target Or Adapter
|
||||
|
||||
Adds support for a new install target (e.g., Gemini, CodeBuddy), including scripts, schemas, and manifest updates.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add a new directory for the install target (e.g., .gemini/, .codebuddy/)
|
||||
2. Add install/uninstall scripts and README(s)
|
||||
3. Update schemas/ecc-install-config.schema.json and/or install-modules.schema.json
|
||||
4. Update manifests/install-modules.json
|
||||
5. Update scripts/lib/install-manifests.js and scripts/lib/install-targets/<target>.js
|
||||
6. Add or update tests for the new install target
|
||||
|
||||
**Files typically involved**:
|
||||
- `.<target>/*`
|
||||
- `schemas/ecc-install-config.schema.json`
|
||||
- `schemas/install-modules.schema.json`
|
||||
- `manifests/install-modules.json`
|
||||
- `scripts/lib/install-manifests.js`
|
||||
- `scripts/lib/install-targets/*.js`
|
||||
- `tests/lib/install-targets.test.js`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Add a new directory for the install target (e.g., .gemini/, .codebuddy/)
|
||||
Add install/uninstall scripts and README(s)
|
||||
Update schemas/ecc-install-config.schema.json and/or install-modules.schema.json
|
||||
Update manifests/install-modules.json
|
||||
Update scripts/lib/install-manifests.js and scripts/lib/install-targets/<target>.js
|
||||
Add or update tests for the new install target
|
||||
```
|
||||
|
||||
### Update Hooks Or Automation
|
||||
|
||||
Refactors or fixes hooks and automation scripts for CI, formatting, or agent workflow integration.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit hooks/hooks.json to update hook configuration
|
||||
2. Edit or add scripts/hooks/*.js or scripts/hooks/*.sh for hook logic
|
||||
3. Update or add tests for the hooks in tests/hooks/*.test.js
|
||||
4. Optionally update related scripts or documentation
|
||||
|
||||
**Files typically involved**:
|
||||
- `hooks/hooks.json`
|
||||
- `scripts/hooks/*.js`
|
||||
- `scripts/hooks/*.sh`
|
||||
- `tests/hooks/*.test.js`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit hooks/hooks.json to update hook configuration
|
||||
Edit or add scripts/hooks/*.js or scripts/hooks/*.sh for hook logic
|
||||
Update or add tests for the hooks in tests/hooks/*.test.js
|
||||
Optionally update related scripts or documentation
|
||||
```
|
||||
|
||||
### Documentation Sync And Localization
|
||||
|
||||
Updates documentation and ensures Chinese and English docs are in sync, including AGENTS.md and README files.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit AGENTS.md, README.md, README.zh-CN.md
|
||||
2. Edit docs/zh-CN/AGENTS.md, docs/zh-CN/README.md
|
||||
3. Optionally update skills/*/SKILL.md and .agents/skills/*/SKILL.md for doc improvements
|
||||
4. Edit WORKING-CONTEXT.md or the-shortform-guide.md as needed
|
||||
|
||||
**Files typically involved**:
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
- `docs/zh-CN/README.md`
|
||||
- `skills/*/SKILL.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `WORKING-CONTEXT.md`
|
||||
- `the-shortform-guide.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit AGENTS.md, README.md, README.zh-CN.md
|
||||
Edit docs/zh-CN/AGENTS.md, docs/zh-CN/README.md
|
||||
Optionally update skills/*/SKILL.md and .agents/skills/*/SKILL.md for doc improvements
|
||||
Edit WORKING-CONTEXT.md or the-shortform-guide.md as needed
|
||||
```
|
||||
|
||||
### Dependency Or Ci Update
|
||||
|
||||
Updates dependencies or CI workflow files, often via automated bots like dependabot.
|
||||
|
||||
**Frequency**: ~4 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit .github/workflows/*.yml to update actions or workflow steps
|
||||
2. Edit package.json, yarn.lock, or package-lock.json for dependency updates
|
||||
3. Optionally update related scripts or lockfiles
|
||||
|
||||
**Files typically involved**:
|
||||
- `.github/workflows/*.yml`
|
||||
- `package.json`
|
||||
- `yarn.lock`
|
||||
- `package-lock.json`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit .github/workflows/*.yml to update actions or workflow steps
|
||||
Edit package.json, yarn.lock, or package-lock.json for dependency updates
|
||||
Optionally update related scripts or lockfiles
|
||||
```
|
||||
|
||||
|
||||
## 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 or Update a Command Workflow
|
||||
**Trigger:** When introducing or improving a command-driven workflow (e.g., PRP, code review, refactoring)
|
||||
**Command:** `/add-command`
|
||||
|
||||
1. Create or update a markdown file in `commands/` (e.g., `commands/prp-*.md`).
|
||||
2. If relevant, update or add supporting files in `.claude/commands/`.
|
||||
3. Optionally update documentation or references to the command in `README.md` or `AGENTS.md`.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
# Add a new PRP command workflow
|
||||
touch commands/prp-enhanced.md
|
||||
# Optionally update supporting files
|
||||
vim .claude/commands/prp-enhanced.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Refactor Skill or Core Logic
|
||||
**Trigger:** When improving, reorganizing, or merging existing skill or core logic for maintainability or performance
|
||||
**Command:** `/refactor-skill`
|
||||
|
||||
1. Edit multiple `SKILL.md` files in `skills/` or `.agents/skills/`.
|
||||
2. Update documentation: `AGENTS.md`, `README.md`, `README.zh-CN.md`, `docs/zh-CN/AGENTS.md`, `docs/zh-CN/README.md`.
|
||||
3. Update `manifests/install-modules.json` or related manifests as needed.
|
||||
4. Remove, merge, or rename legacy command or skill files.
|
||||
5. Optionally update or add tests for the refactored logic.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
# Refactor multiple skills
|
||||
vim skills/skillA/SKILL.md skills/skillB/SKILL.md
|
||||
# Update manifests and docs
|
||||
vim manifests/install-modules.json README.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update Install Target
|
||||
**Trigger:** When supporting a new external tool or environment as an install target
|
||||
**Command:** `/add-install-target`
|
||||
|
||||
1. Create or update install scripts in a dedicated directory (e.g., `.codebuddy/`, `.gemini/`).
|
||||
2. Add or update install target logic in `scripts/lib/install-targets/`.
|
||||
3. Update `manifests/install-modules.json` and `schemas/ecc-install-config.schema.json`.
|
||||
4. Update or add tests for the new install target in `tests/lib/install-targets.test.js`.
|
||||
5. Update registry logic if necessary.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
# Add a Gemini install target
|
||||
mkdir .gemini
|
||||
touch .gemini/install.sh
|
||||
vim scripts/lib/install-targets/gemini.js
|
||||
# Update schemas and manifests
|
||||
vim schemas/ecc-install-config.schema.json manifests/install-modules.json
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Update or Add CI/CD Workflow
|
||||
**Trigger:** When improving, fixing, or adding CI/CD automation (e.g., dependency updates, release validation)
|
||||
**Command:** `/update-ci`
|
||||
|
||||
1. Edit or add YAML files in `.github/workflows/`.
|
||||
2. Optionally update related scripts or lockfiles (`yarn.lock`, `package-lock.json`).
|
||||
3. Optionally update hooks or validation scripts.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
# Add a new CI workflow
|
||||
touch .github/workflows/dependency-check.yml
|
||||
# Update lockfiles if needed
|
||||
yarn install
|
||||
```
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
- **Test Files:** Use the `*.test.js` naming pattern.
|
||||
- Example: `installTargets.test.js`
|
||||
- **Framework:** Not explicitly specified; use standard Node.js or your preferred JS testing framework.
|
||||
- **Placement:** Tests are typically placed alongside implementation or in a `tests/` directory.
|
||||
|
||||
**Example Test File:**
|
||||
```js
|
||||
// tests/lib/install-targets.test.js
|
||||
import { installTarget } from '../../scripts/lib/install-targets/gemini.js';
|
||||
|
||||
test('should install Gemini target', () => {
|
||||
expect(installTarget()).toBe(true);
|
||||
});
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Purpose |
|
||||
|---------------------|--------------------------------------------------------------|
|
||||
| /add-skill | Add or update a skill, including documentation and manifests |
|
||||
| /add-command | Add or update a command workflow |
|
||||
| /refactor-skill | Refactor skill or core logic and update documentation |
|
||||
| /add-install-target | Add or update an install target integration |
|
||||
| /update-ci | Add or update CI/CD workflow files |
|
||||
```
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
"commandFiles": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-new-skill.md"
|
||||
".claude/commands/add-or-update-skill.md"
|
||||
],
|
||||
"updatedAt": "2026-04-02T13:23:38.785Z"
|
||||
"updatedAt": "2026-04-02T13:44:44.593Z"
|
||||
}
|
||||
Reference in New Issue
Block a user