mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-04-02 23:23:31 +08:00
Compare commits
15 Commits
main
...
ecc-tools/
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
cdbaf9feff | ||
|
|
8f2170f9cf | ||
|
|
7ac28b45eb | ||
|
|
d7bffc3f5a | ||
|
|
e9aeeb13d7 | ||
|
|
d0103898bb | ||
|
|
4356273cfa | ||
|
|
b5907ccfbd | ||
|
|
7e0d803bed | ||
|
|
4b6de88b90 | ||
|
|
0f2089e2ad | ||
|
|
1e1edd1b9e | ||
|
|
a68feb7ac7 | ||
|
|
eb564ee4b6 | ||
|
|
ab19584689 |
@@ -1,442 +1,188 @@
|
|||||||
---
|
```markdown
|
||||||
name: everything-claude-code-conventions
|
# everything-claude-code Development Patterns
|
||||||
description: Development conventions and patterns for everything-claude-code. JavaScript project with conventional commits.
|
|
||||||
---
|
|
||||||
|
|
||||||
# Everything Claude Code Conventions
|
> Auto-generated skill from repository analysis
|
||||||
|
|
||||||
> Generated from [affaan-m/everything-claude-code](https://github.com/affaan-m/everything-claude-code) on 2026-03-20
|
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
This skill teaches Claude the development patterns and conventions used in everything-claude-code.
|
This skill documents the core development patterns, coding conventions, and agentic workflows used in the `everything-claude-code` (ECC) repository. The project is written in JavaScript (no framework detected) and implements modular, agent-driven automation and installable skills. This guide covers how to contribute new skills, commands, install targets, agent definitions, and more, following the repository's conventions and workflows.
|
||||||
|
|
||||||
## Tech Stack
|
## Coding Conventions
|
||||||
|
|
||||||
- **Primary Language**: JavaScript
|
ECC follows consistent JavaScript coding and repository organization conventions:
|
||||||
- **Architecture**: hybrid module organization
|
|
||||||
- **Test Location**: separate
|
|
||||||
|
|
||||||
## When to Use This Skill
|
### File Naming
|
||||||
|
|
||||||
Activate this skill when:
|
- Use **camelCase** for JavaScript files and modules.
|
||||||
- Making changes to this repository
|
- Example: `myModule.js`, `installTarget.js`
|
||||||
- Adding new features following established patterns
|
|
||||||
- Writing tests that match project conventions
|
|
||||||
- Creating commits with proper message format
|
|
||||||
|
|
||||||
## Commit Conventions
|
### Import Style
|
||||||
|
|
||||||
Follow these commit message conventions based on 500 analyzed commits.
|
- Use **relative imports** for internal modules.
|
||||||
|
```js
|
||||||
|
// Good
|
||||||
|
const utils = require('./utils');
|
||||||
|
import { doThing } from '../lib/doThing.js';
|
||||||
|
```
|
||||||
|
|
||||||
### Commit Style: Conventional Commits
|
### Export Style
|
||||||
|
|
||||||
### Prefixes Used
|
- Both **CommonJS** and **ES module** exports are used, depending on context.
|
||||||
|
```js
|
||||||
|
// CommonJS
|
||||||
|
module.exports = function doSomething() { ... };
|
||||||
|
|
||||||
- `fix`
|
// ES Module
|
||||||
- `test`
|
export function doSomethingElse() { ... }
|
||||||
- `feat`
|
```
|
||||||
- `docs`
|
|
||||||
|
|
||||||
### Message Guidelines
|
### Commit Messages
|
||||||
|
|
||||||
- Average message length: ~65 characters
|
- Prefix with `fix:`, `feat:`, `docs:`, or `chore:`
|
||||||
- Keep first line concise and descriptive
|
- Keep messages concise (average ~56 characters)
|
||||||
- Use imperative mood ("Add feature" not "Added feature")
|
```
|
||||||
|
feat: add support for new install target
|
||||||
|
fix: resolve agent prompt parsing bug
|
||||||
|
```
|
||||||
|
|
||||||
|
## Workflows
|
||||||
|
|
||||||
*Commit message example*
|
### Add or Update a Skill
|
||||||
|
|
||||||
```text
|
**Trigger:** When introducing or updating a skill for agentic workflows
|
||||||
feat(rules): add C# language support
|
**Command:** `/add-skill`
|
||||||
|
|
||||||
|
1. Create or update a `SKILL.md` file under `skills/{skill-name}/` or `.agents/skills/{skill-name}/`.
|
||||||
|
2. Optionally update `AGENTS.md`, `README.md`, and localized docs (e.g., `README.zh-CN.md`).
|
||||||
|
3. Update `manifests/install-modules.json` and/or `install-components.json` if the skill is installable.
|
||||||
|
4. Optionally add or update related agent markdown files.
|
||||||
|
5. Optionally update tests or scripts if the skill introduces new hooks or behaviors.
|
||||||
|
|
||||||
|
**Example:**
|
||||||
|
```shell
|
||||||
|
mkdir -p skills/myNewSkill
|
||||||
|
touch skills/myNewSkill/SKILL.md
|
||||||
|
# Edit SKILL.md with documentation
|
||||||
```
|
```
|
||||||
|
|
||||||
*Commit message example*
|
|
||||||
|
|
||||||
```text
|
|
||||||
chore(deps-dev): bump flatted (#675)
|
|
||||||
```
|
|
||||||
|
|
||||||
*Commit message example*
|
|
||||||
|
|
||||||
```text
|
|
||||||
fix: auto-detect ECC root from plugin cache when CLAUDE_PLUGIN_ROOT is unset (#547) (#691)
|
|
||||||
```
|
|
||||||
|
|
||||||
*Commit message example*
|
|
||||||
|
|
||||||
```text
|
|
||||||
docs: add Antigravity setup and usage guide (#552)
|
|
||||||
```
|
|
||||||
|
|
||||||
*Commit message example*
|
|
||||||
|
|
||||||
```text
|
|
||||||
merge: PR #529 — feat(skills): add documentation-lookup, bun-runtime, nextjs-turbopack; feat(agents): add rust-reviewer
|
|
||||||
```
|
|
||||||
|
|
||||||
*Commit message example*
|
|
||||||
|
|
||||||
```text
|
|
||||||
Revert "Add Kiro IDE support (.kiro/) (#548)"
|
|
||||||
```
|
|
||||||
|
|
||||||
*Commit message example*
|
|
||||||
|
|
||||||
```text
|
|
||||||
Add Kiro IDE support (.kiro/) (#548)
|
|
||||||
```
|
|
||||||
|
|
||||||
*Commit message example*
|
|
||||||
|
|
||||||
```text
|
|
||||||
feat: add block-no-verify hook for Claude Code and Cursor (#649)
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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.
|
|
||||||
|
|
||||||
### Database Migration
|
|
||||||
|
|
||||||
Database schema changes with migration files
|
|
||||||
|
|
||||||
**Frequency**: ~2 times per month
|
|
||||||
|
|
||||||
**Steps**:
|
|
||||||
1. Create migration file
|
|
||||||
2. Update schema definitions
|
|
||||||
3. Generate/update types
|
|
||||||
|
|
||||||
**Files typically involved**:
|
|
||||||
- `**/schema.*`
|
|
||||||
- `migrations/*`
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
|
||||||
```
|
|
||||||
feat: implement --with/--without selective install flags (#679)
|
|
||||||
fix: sync catalog counts with filesystem (27 agents, 113 skills, 58 commands) (#693)
|
|
||||||
feat(rules): add Rust language rules (rebased #660) (#686)
|
|
||||||
```
|
|
||||||
|
|
||||||
### Feature Development
|
|
||||||
|
|
||||||
Standard feature implementation workflow
|
|
||||||
|
|
||||||
**Frequency**: ~22 times per month
|
|
||||||
|
|
||||||
**Steps**:
|
|
||||||
1. Add feature implementation
|
|
||||||
2. Add tests for feature
|
|
||||||
3. Update documentation
|
|
||||||
|
|
||||||
**Files typically involved**:
|
|
||||||
- `manifests/*`
|
|
||||||
- `schemas/*`
|
|
||||||
- `**/*.test.*`
|
|
||||||
- `**/api/**`
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
|
||||||
```
|
|
||||||
feat(skills): add documentation-lookup, bun-runtime, nextjs-turbopack; feat(agents): add rust-reviewer
|
|
||||||
docs(skills): align documentation-lookup with CONTRIBUTING template; add cross-harness (Codex/Cursor) skill copies
|
|
||||||
fix: address PR review — skill template (When to use, How it works, Examples), bun.lock, next build note, rust-reviewer CI note, doc-lookup privacy/uncertainty
|
|
||||||
```
|
|
||||||
|
|
||||||
### Add Language Rules
|
|
||||||
|
|
||||||
Adds a new programming language to the rules system, including coding style, hooks, patterns, security, and testing guidelines.
|
|
||||||
|
|
||||||
**Frequency**: ~2 times per month
|
|
||||||
|
|
||||||
**Steps**:
|
|
||||||
1. Create a new directory under rules/{language}/
|
|
||||||
2. Add coding-style.md, hooks.md, patterns.md, security.md, and testing.md files with language-specific content
|
|
||||||
3. Optionally reference or link to related skills
|
|
||||||
|
|
||||||
**Files typically involved**:
|
|
||||||
- `rules/*/coding-style.md`
|
|
||||||
- `rules/*/hooks.md`
|
|
||||||
- `rules/*/patterns.md`
|
|
||||||
- `rules/*/security.md`
|
|
||||||
- `rules/*/testing.md`
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
|
||||||
```
|
|
||||||
Create a new directory under rules/{language}/
|
|
||||||
Add coding-style.md, hooks.md, patterns.md, security.md, and testing.md files with language-specific content
|
|
||||||
Optionally reference or link to related skills
|
|
||||||
```
|
|
||||||
|
|
||||||
### Add New Skill
|
|
||||||
|
|
||||||
Adds a new skill to the system, documenting its workflow, triggers, and usage, often with supporting scripts.
|
|
||||||
|
|
||||||
**Frequency**: ~4 times per month
|
|
||||||
|
|
||||||
**Steps**:
|
|
||||||
1. Create a new directory under skills/{skill-name}/
|
|
||||||
2. Add SKILL.md with documentation (When to Use, How It Works, Examples, etc.)
|
|
||||||
3. Optionally add scripts or supporting files under skills/{skill-name}/scripts/
|
|
||||||
4. Address review feedback and iterate on documentation
|
|
||||||
|
|
||||||
**Files typically involved**:
|
|
||||||
- `skills/*/SKILL.md`
|
|
||||||
- `skills/*/scripts/*.sh`
|
|
||||||
- `skills/*/scripts/*.js`
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
|
||||||
```
|
|
||||||
Create a new directory under skills/{skill-name}/
|
|
||||||
Add SKILL.md with documentation (When to Use, How It Works, Examples, etc.)
|
|
||||||
Optionally add scripts or supporting files under skills/{skill-name}/scripts/
|
|
||||||
Address review feedback and iterate on documentation
|
|
||||||
```
|
|
||||||
|
|
||||||
### Add New Agent
|
|
||||||
|
|
||||||
Adds a new agent to the system for code review, build resolution, or other automated tasks.
|
|
||||||
|
|
||||||
**Frequency**: ~2 times per month
|
|
||||||
|
|
||||||
**Steps**:
|
|
||||||
1. Create a new agent markdown file under agents/{agent-name}.md
|
|
||||||
2. Register the agent in AGENTS.md
|
|
||||||
3. Optionally update README.md and docs/COMMAND-AGENT-MAP.md
|
|
||||||
|
|
||||||
**Files typically involved**:
|
|
||||||
- `agents/*.md`
|
|
||||||
- `AGENTS.md`
|
|
||||||
- `README.md`
|
|
||||||
- `docs/COMMAND-AGENT-MAP.md`
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
|
||||||
```
|
|
||||||
Create a new agent markdown file under agents/{agent-name}.md
|
|
||||||
Register the agent in AGENTS.md
|
|
||||||
Optionally update README.md and docs/COMMAND-AGENT-MAP.md
|
|
||||||
```
|
|
||||||
|
|
||||||
### Add New Workflow Surface
|
|
||||||
|
|
||||||
Adds or updates a workflow entrypoint. Default to skills-first; only add a command shim when legacy slash compatibility is still required.
|
|
||||||
|
|
||||||
**Frequency**: ~1 times per month
|
|
||||||
|
|
||||||
**Steps**:
|
|
||||||
1. Create or update the canonical workflow under skills/{skill-name}/SKILL.md
|
|
||||||
2. Only if needed, add or update commands/{command-name}.md as a compatibility shim
|
|
||||||
|
|
||||||
**Files typically involved**:
|
|
||||||
- `skills/*/SKILL.md`
|
|
||||||
- `commands/*.md` (only when a legacy shim is intentionally retained)
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
|
||||||
```
|
|
||||||
Create or update the canonical skill under skills/{skill-name}/SKILL.md
|
|
||||||
Only if needed, add or update commands/{command-name}.md as a compatibility shim
|
|
||||||
```
|
|
||||||
|
|
||||||
### Sync Catalog Counts
|
|
||||||
|
|
||||||
Synchronizes the documented counts of agents, skills, and commands in AGENTS.md and README.md with the actual repository state.
|
|
||||||
|
|
||||||
**Frequency**: ~3 times per month
|
|
||||||
|
|
||||||
**Steps**:
|
|
||||||
1. Update agent, skill, and command counts in AGENTS.md
|
|
||||||
2. Update the same counts in README.md (quick-start, comparison table, etc.)
|
|
||||||
3. Optionally update other documentation files
|
|
||||||
|
|
||||||
**Files typically involved**:
|
|
||||||
- `AGENTS.md`
|
|
||||||
- `README.md`
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
|
||||||
```
|
|
||||||
Update agent, skill, and command counts in AGENTS.md
|
|
||||||
Update the same counts in README.md (quick-start, comparison table, etc.)
|
|
||||||
Optionally update other documentation files
|
|
||||||
```
|
|
||||||
|
|
||||||
### Add Cross Harness Skill Copies
|
|
||||||
|
|
||||||
Adds skill copies for different agent harnesses (e.g., Codex, Cursor, Antigravity) to ensure compatibility across platforms.
|
|
||||||
|
|
||||||
**Frequency**: ~2 times per month
|
|
||||||
|
|
||||||
**Steps**:
|
|
||||||
1. Copy or adapt SKILL.md to .agents/skills/{skill}/SKILL.md and/or .cursor/skills/{skill}/SKILL.md
|
|
||||||
2. Optionally add harness-specific openai.yaml or config files
|
|
||||||
3. Address review feedback to align with CONTRIBUTING template
|
|
||||||
|
|
||||||
**Files typically involved**:
|
|
||||||
- `.agents/skills/*/SKILL.md`
|
|
||||||
- `.cursor/skills/*/SKILL.md`
|
|
||||||
- `.agents/skills/*/agents/openai.yaml`
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
|
||||||
```
|
|
||||||
Copy or adapt SKILL.md to .agents/skills/{skill}/SKILL.md and/or .cursor/skills/{skill}/SKILL.md
|
|
||||||
Optionally add harness-specific openai.yaml or config files
|
|
||||||
Address review feedback to align with CONTRIBUTING template
|
|
||||||
```
|
|
||||||
|
|
||||||
### Add Or Update Hook
|
|
||||||
|
|
||||||
Adds or updates git or bash hooks to enforce workflow, quality, or security policies.
|
|
||||||
|
|
||||||
**Frequency**: ~1 times per month
|
|
||||||
|
|
||||||
**Steps**:
|
|
||||||
1. Add or update hook scripts in hooks/ or scripts/hooks/
|
|
||||||
2. Register the hook in hooks/hooks.json or similar config
|
|
||||||
3. Optionally add or update tests in tests/hooks/
|
|
||||||
|
|
||||||
**Files typically involved**:
|
|
||||||
- `hooks/*.hook`
|
|
||||||
- `hooks/hooks.json`
|
|
||||||
- `scripts/hooks/*.js`
|
|
||||||
- `tests/hooks/*.test.js`
|
|
||||||
- `.cursor/hooks.json`
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
|
||||||
```
|
|
||||||
Add or update hook scripts in hooks/ or scripts/hooks/
|
|
||||||
Register the hook in hooks/hooks.json or similar config
|
|
||||||
Optionally add or update tests in tests/hooks/
|
|
||||||
```
|
|
||||||
|
|
||||||
### Address Review Feedback
|
|
||||||
|
|
||||||
Addresses code review feedback by updating documentation, scripts, or configuration for clarity, correctness, or convention alignment.
|
|
||||||
|
|
||||||
**Frequency**: ~4 times per month
|
|
||||||
|
|
||||||
**Steps**:
|
|
||||||
1. Edit SKILL.md, agent, or command files to address reviewer comments
|
|
||||||
2. Update examples, headings, or configuration as requested
|
|
||||||
3. Iterate until all review feedback is resolved
|
|
||||||
|
|
||||||
**Files typically involved**:
|
|
||||||
- `skills/*/SKILL.md`
|
|
||||||
- `agents/*.md`
|
|
||||||
- `commands/*.md`
|
|
||||||
- `.agents/skills/*/SKILL.md`
|
|
||||||
- `.cursor/skills/*/SKILL.md`
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
|
||||||
```
|
|
||||||
Edit SKILL.md, agent, or command files to address reviewer comments
|
|
||||||
Update examples, headings, or configuration as requested
|
|
||||||
Iterate until all review feedback is resolved
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## 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 adding or updating a repeatable workflow command
|
||||||
|
**Command:** `/add-command`
|
||||||
|
|
||||||
|
1. Create or update a markdown file in `commands/` (e.g., `prp-*.md`, `gan-*.md`, `santa-loop.md`).
|
||||||
|
2. Document workflow phases, usage, and outputs in the file.
|
||||||
|
3. Optionally update related skills or agent definitions.
|
||||||
|
4. Optionally add shell scripts or orchestrators if automation is needed.
|
||||||
|
5. Optionally update `AGENTS.md` or `README.md` to reference the new command.
|
||||||
|
|
||||||
|
**Example:**
|
||||||
|
```shell
|
||||||
|
touch commands/prp-myworkflow.md
|
||||||
|
# Document the workflow steps in markdown
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Add or Update an Install Target
|
||||||
|
|
||||||
|
**Trigger:** When supporting a new IDE/platform or updating install logic
|
||||||
|
**Command:** `/add-install-target`
|
||||||
|
|
||||||
|
1. Add or update install scripts (`install.sh`, `install.js`, `uninstall.sh`, `uninstall.js`) in a new or existing directory (e.g., `.codebuddy/`).
|
||||||
|
2. Update `manifests/install-modules.json` and `schemas/ecc-install-config.schema.json`.
|
||||||
|
3. Update `scripts/lib/install-manifests.js` and `scripts/lib/install-targets/{target}.js`.
|
||||||
|
4. Add or update tests for install targets.
|
||||||
|
5. Optionally update `README.md` or `AGENTS.md`.
|
||||||
|
|
||||||
|
**Example:**
|
||||||
|
```shell
|
||||||
|
mkdir -p .codebuddy
|
||||||
|
touch .codebuddy/install.sh
|
||||||
|
# Implement install logic
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Update Hooks and Hook Tests
|
||||||
|
|
||||||
|
**Trigger:** When refactoring, fixing, or extending system hooks
|
||||||
|
**Command:** `/update-hook`
|
||||||
|
|
||||||
|
1. Edit `hooks/hooks.json` to change configuration or add/remove hooks.
|
||||||
|
2. Edit or add `scripts/hooks/*.js` to implement hook logic.
|
||||||
|
3. Edit or add `tests/hooks/*.test.js` to cover new or changed behaviors.
|
||||||
|
4. Optionally update related scripts or documentation.
|
||||||
|
|
||||||
|
**Example:**
|
||||||
|
```json
|
||||||
|
// hooks/hooks.json
|
||||||
|
{
|
||||||
|
"pre-commit": ["format", "typecheck"]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Dependency Bump via Dependabot
|
||||||
|
|
||||||
|
**Trigger:** When updating dependencies for security or features
|
||||||
|
**Command:** `/bump-dependency`
|
||||||
|
|
||||||
|
1. Update dependency version in `package.json`, `yarn.lock`, or workflow YAML files.
|
||||||
|
2. Commit with a standardized message (often by dependabot).
|
||||||
|
3. Optionally update related documentation or changelogs.
|
||||||
|
|
||||||
|
**Example:**
|
||||||
|
```json
|
||||||
|
// package.json
|
||||||
|
"dependencies": {
|
||||||
|
"some-lib": "^2.0.0"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Add or Update Agent Definition
|
||||||
|
|
||||||
|
**Trigger:** When adding or modifying agent definitions/prompts
|
||||||
|
**Command:** `/add-agent`
|
||||||
|
|
||||||
|
1. Add or update agent markdown files (`agents/*.md`).
|
||||||
|
2. Add or update prompt files (`.opencode/prompts/agents/*.txt`).
|
||||||
|
3. Update `.opencode/opencode.json` to register new agents.
|
||||||
|
4. Update `AGENTS.md` to document new agents.
|
||||||
|
5. Optionally update related skills or orchestrators.
|
||||||
|
|
||||||
|
**Example:**
|
||||||
|
```shell
|
||||||
|
touch agents/myAgent.md
|
||||||
|
touch .opencode/prompts/agents/myAgent.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
## Testing Patterns
|
||||||
|
|
||||||
|
- Test files follow the pattern `*.test.js`.
|
||||||
|
- Testing framework is **unknown** (not detected), but test files are placed alongside code or in `tests/` directories.
|
||||||
|
- Example test file:
|
||||||
|
```js
|
||||||
|
// tests/hooks/formatHook.test.js
|
||||||
|
const formatHook = require('../../scripts/hooks/formatHook');
|
||||||
|
test('should format code correctly', () => {
|
||||||
|
// test implementation
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
| Command | Purpose |
|
||||||
|
|--------------------|----------------------------------------------------------------|
|
||||||
|
| /add-skill | Add or update a skill and its documentation |
|
||||||
|
| /add-command | Add or update a workflow command |
|
||||||
|
| /add-install-target| Add or update an install target (IDE/platform/environment) |
|
||||||
|
| /update-hook | Refactor, fix, or extend system hooks and their tests |
|
||||||
|
| /bump-dependency | Update dependency versions in package or workflow files |
|
||||||
|
| /add-agent | Add or update agent definitions and prompts |
|
||||||
|
```
|
||||||
|
|||||||
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 for an agentic workflow, including documentation and sometimes related manifests.
|
||||||
|
|
||||||
|
## Common Files
|
||||||
|
|
||||||
|
- `skills/*/SKILL.md`
|
||||||
|
- `.agents/skills/*/SKILL.md`
|
||||||
|
- `AGENTS.md`
|
||||||
|
- `README.md`
|
||||||
|
- `README.zh-CN.md`
|
||||||
|
- `docs/zh-CN/AGENTS.md`
|
||||||
|
|
||||||
|
## Suggested Sequence
|
||||||
|
|
||||||
|
1. Understand the current state and failure mode before editing.
|
||||||
|
2. Make the smallest coherent change that satisfies the workflow goal.
|
||||||
|
3. Run the most relevant verification for touched files.
|
||||||
|
4. Summarize what changed and what still needs review.
|
||||||
|
|
||||||
|
## Typical Commit Signals
|
||||||
|
|
||||||
|
- Create or update a SKILL.md file under skills/{skill-name}/ or .agents/skills/{skill-name}/
|
||||||
|
- Optionally update AGENTS.md, README.md, and localized docs
|
||||||
|
- Update manifests/install-modules.json and/or install-components.json if the skill is part of installable modules
|
||||||
|
- Optionally add or update related agent markdown files
|
||||||
|
- Optionally update tests or scripts if the skill introduces new hooks or behaviors
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
- Treat this as a scaffold, not a hard-coded script.
|
||||||
|
- Update the command if the workflow evolves materially.
|
||||||
@@ -14,10 +14,10 @@ Standard feature implementation workflow
|
|||||||
|
|
||||||
## Common Files
|
## Common Files
|
||||||
|
|
||||||
- `manifests/*`
|
- `.opencode/*`
|
||||||
- `schemas/*`
|
- `.opencode/plugins/*`
|
||||||
|
- `.opencode/plugins/lib/*`
|
||||||
- `**/*.test.*`
|
- `**/*.test.*`
|
||||||
- `**/api/**`
|
|
||||||
|
|
||||||
## Suggested Sequence
|
## Suggested Sequence
|
||||||
|
|
||||||
|
|||||||
35
.claude/commands/refactoring.md
Normal file
35
.claude/commands/refactoring.md
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
---
|
||||||
|
name: refactoring
|
||||||
|
description: Workflow command scaffold for refactoring in everything-claude-code.
|
||||||
|
allowed_tools: ["Bash", "Read", "Write", "Grep", "Glob"]
|
||||||
|
---
|
||||||
|
|
||||||
|
# /refactoring
|
||||||
|
|
||||||
|
Use this workflow when working on **refactoring** in `everything-claude-code`.
|
||||||
|
|
||||||
|
## Goal
|
||||||
|
|
||||||
|
Code refactoring and cleanup workflow
|
||||||
|
|
||||||
|
## Common Files
|
||||||
|
|
||||||
|
- `src/**/*`
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
- Ensure tests pass before refactor
|
||||||
|
- Refactor code structure
|
||||||
|
- Verify tests still pass
|
||||||
|
|
||||||
|
## 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",
|
"version": "1.3",
|
||||||
"schemaVersion": "1.0",
|
"schemaVersion": "1.0",
|
||||||
"generatedBy": "ecc-tools",
|
"generatedBy": "ecc-tools",
|
||||||
"generatedAt": "2026-03-20T12:07:36.496Z",
|
"generatedAt": "2026-04-01T23:05:46.781Z",
|
||||||
"repo": "https://github.com/affaan-m/everything-claude-code",
|
"repo": "https://github.com/affaan-m/everything-claude-code",
|
||||||
"profiles": {
|
"profiles": {
|
||||||
"requested": "full",
|
"requested": "full",
|
||||||
@@ -148,9 +148,9 @@
|
|||||||
".claude/research/everything-claude-code-research-playbook.md",
|
".claude/research/everything-claude-code-research-playbook.md",
|
||||||
".claude/team/everything-claude-code-team-config.json",
|
".claude/team/everything-claude-code-team-config.json",
|
||||||
".claude/enterprise/controls.md",
|
".claude/enterprise/controls.md",
|
||||||
".claude/commands/database-migration.md",
|
|
||||||
".claude/commands/feature-development.md",
|
".claude/commands/feature-development.md",
|
||||||
".claude/commands/add-language-rules.md"
|
".claude/commands/refactoring.md",
|
||||||
|
".claude/commands/add-or-update-skill.md"
|
||||||
],
|
],
|
||||||
"packageFiles": {
|
"packageFiles": {
|
||||||
"runtime-core": [
|
"runtime-core": [
|
||||||
@@ -178,9 +178,9 @@
|
|||||||
".claude/enterprise/controls.md"
|
".claude/enterprise/controls.md"
|
||||||
],
|
],
|
||||||
"workflow-pack": [
|
"workflow-pack": [
|
||||||
".claude/commands/database-migration.md",
|
|
||||||
".claude/commands/feature-development.md",
|
".claude/commands/feature-development.md",
|
||||||
".claude/commands/add-language-rules.md"
|
".claude/commands/refactoring.md",
|
||||||
|
".claude/commands/add-or-update-skill.md"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"moduleFiles": {
|
"moduleFiles": {
|
||||||
@@ -209,9 +209,9 @@
|
|||||||
".claude/enterprise/controls.md"
|
".claude/enterprise/controls.md"
|
||||||
],
|
],
|
||||||
"workflow-pack": [
|
"workflow-pack": [
|
||||||
".claude/commands/database-migration.md",
|
|
||||||
".claude/commands/feature-development.md",
|
".claude/commands/feature-development.md",
|
||||||
".claude/commands/add-language-rules.md"
|
".claude/commands/refactoring.md",
|
||||||
|
".claude/commands/add-or-update-skill.md"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
@@ -285,11 +285,6 @@
|
|||||||
"path": ".claude/enterprise/controls.md",
|
"path": ".claude/enterprise/controls.md",
|
||||||
"description": "Enterprise governance scaffold for approvals, audit posture, and escalation."
|
"description": "Enterprise governance scaffold for approvals, audit posture, and escalation."
|
||||||
},
|
},
|
||||||
{
|
|
||||||
"moduleId": "workflow-pack",
|
|
||||||
"path": ".claude/commands/database-migration.md",
|
|
||||||
"description": "Workflow command scaffold for database-migration."
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"moduleId": "workflow-pack",
|
"moduleId": "workflow-pack",
|
||||||
"path": ".claude/commands/feature-development.md",
|
"path": ".claude/commands/feature-development.md",
|
||||||
@@ -297,22 +292,27 @@
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"moduleId": "workflow-pack",
|
"moduleId": "workflow-pack",
|
||||||
"path": ".claude/commands/add-language-rules.md",
|
"path": ".claude/commands/refactoring.md",
|
||||||
"description": "Workflow command scaffold for add-language-rules."
|
"description": "Workflow command scaffold for refactoring."
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"moduleId": "workflow-pack",
|
||||||
|
"path": ".claude/commands/add-or-update-skill.md",
|
||||||
|
"description": "Workflow command scaffold for add-or-update-skill."
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"workflows": [
|
"workflows": [
|
||||||
{
|
|
||||||
"command": "database-migration",
|
|
||||||
"path": ".claude/commands/database-migration.md"
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"command": "feature-development",
|
"command": "feature-development",
|
||||||
"path": ".claude/commands/feature-development.md"
|
"path": ".claude/commands/feature-development.md"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"command": "add-language-rules",
|
"command": "refactoring",
|
||||||
"path": ".claude/commands/add-language-rules.md"
|
"path": ".claude/commands/refactoring.md"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"command": "add-or-update-skill",
|
||||||
|
"path": ".claude/commands/add-or-update-skill.md"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"adapters": {
|
"adapters": {
|
||||||
@@ -320,9 +320,9 @@
|
|||||||
"skillPath": ".claude/skills/everything-claude-code/SKILL.md",
|
"skillPath": ".claude/skills/everything-claude-code/SKILL.md",
|
||||||
"identityPath": ".claude/identity.json",
|
"identityPath": ".claude/identity.json",
|
||||||
"commandPaths": [
|
"commandPaths": [
|
||||||
".claude/commands/database-migration.md",
|
|
||||||
".claude/commands/feature-development.md",
|
".claude/commands/feature-development.md",
|
||||||
".claude/commands/add-language-rules.md"
|
".claude/commands/refactoring.md",
|
||||||
|
".claude/commands/add-or-update-skill.md"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"codex": {
|
"codex": {
|
||||||
|
|||||||
@@ -10,5 +10,5 @@
|
|||||||
"javascript"
|
"javascript"
|
||||||
],
|
],
|
||||||
"suggestedBy": "ecc-tools-repo-analysis",
|
"suggestedBy": "ecc-tools-repo-analysis",
|
||||||
"createdAt": "2026-03-20T12:07:57.119Z"
|
"createdAt": "2026-04-01T23:06:31.168Z"
|
||||||
}
|
}
|
||||||
@@ -18,4 +18,4 @@ Use this when the task is documentation-heavy, source-sensitive, or requires bro
|
|||||||
|
|
||||||
- Primary language: JavaScript
|
- Primary language: JavaScript
|
||||||
- Framework: Not detected
|
- Framework: Not detected
|
||||||
- Workflows detected: 10
|
- Workflows detected: 8
|
||||||
@@ -4,7 +4,7 @@ Generated by ECC Tools from repository history. Review before treating it as a h
|
|||||||
|
|
||||||
## Commit Workflow
|
## Commit Workflow
|
||||||
|
|
||||||
- Prefer `conventional` commit messaging with prefixes such as fix, test, feat, docs.
|
- Prefer `mixed` commit messaging with prefixes such as fix, feat, docs, chore.
|
||||||
- Keep new changes aligned with the existing pull-request and review flow already present in the repo.
|
- Keep new changes aligned with the existing pull-request and review flow already present in the repo.
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
@@ -24,9 +24,9 @@ Generated by ECC Tools from repository history. Review before treating it as a h
|
|||||||
|
|
||||||
## Detected Workflows
|
## Detected Workflows
|
||||||
|
|
||||||
- database-migration: Database schema changes with migration files
|
|
||||||
- feature-development: Standard feature implementation workflow
|
- feature-development: Standard feature implementation workflow
|
||||||
- add-language-rules: Adds a new programming language to the rules system, including coding style, hooks, patterns, security, and testing guidelines.
|
- refactoring: Code refactoring and cleanup workflow
|
||||||
|
- add-or-update-skill: Adds a new skill or updates an existing skill for an agentic workflow, including documentation and sometimes related manifests.
|
||||||
|
|
||||||
## Review Reminder
|
## Review Reminder
|
||||||
|
|
||||||
|
|||||||
@@ -1,442 +1,188 @@
|
|||||||
---
|
```markdown
|
||||||
name: everything-claude-code-conventions
|
# everything-claude-code Development Patterns
|
||||||
description: Development conventions and patterns for everything-claude-code. JavaScript project with conventional commits.
|
|
||||||
---
|
|
||||||
|
|
||||||
# Everything Claude Code Conventions
|
> Auto-generated skill from repository analysis
|
||||||
|
|
||||||
> Generated from [affaan-m/everything-claude-code](https://github.com/affaan-m/everything-claude-code) on 2026-03-20
|
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
This skill teaches Claude the development patterns and conventions used in everything-claude-code.
|
This skill documents the core development patterns, coding conventions, and agentic workflows used in the `everything-claude-code` (ECC) repository. The project is written in JavaScript (no framework detected) and implements modular, agent-driven automation and installable skills. This guide covers how to contribute new skills, commands, install targets, agent definitions, and more, following the repository's conventions and workflows.
|
||||||
|
|
||||||
## Tech Stack
|
## Coding Conventions
|
||||||
|
|
||||||
- **Primary Language**: JavaScript
|
ECC follows consistent JavaScript coding and repository organization conventions:
|
||||||
- **Architecture**: hybrid module organization
|
|
||||||
- **Test Location**: separate
|
|
||||||
|
|
||||||
## When to Use This Skill
|
### File Naming
|
||||||
|
|
||||||
Activate this skill when:
|
- Use **camelCase** for JavaScript files and modules.
|
||||||
- Making changes to this repository
|
- Example: `myModule.js`, `installTarget.js`
|
||||||
- Adding new features following established patterns
|
|
||||||
- Writing tests that match project conventions
|
|
||||||
- Creating commits with proper message format
|
|
||||||
|
|
||||||
## Commit Conventions
|
### Import Style
|
||||||
|
|
||||||
Follow these commit message conventions based on 500 analyzed commits.
|
- Use **relative imports** for internal modules.
|
||||||
|
```js
|
||||||
|
// Good
|
||||||
|
const utils = require('./utils');
|
||||||
|
import { doThing } from '../lib/doThing.js';
|
||||||
|
```
|
||||||
|
|
||||||
### Commit Style: Conventional Commits
|
### Export Style
|
||||||
|
|
||||||
### Prefixes Used
|
- Both **CommonJS** and **ES module** exports are used, depending on context.
|
||||||
|
```js
|
||||||
|
// CommonJS
|
||||||
|
module.exports = function doSomething() { ... };
|
||||||
|
|
||||||
- `fix`
|
// ES Module
|
||||||
- `test`
|
export function doSomethingElse() { ... }
|
||||||
- `feat`
|
```
|
||||||
- `docs`
|
|
||||||
|
|
||||||
### Message Guidelines
|
### Commit Messages
|
||||||
|
|
||||||
- Average message length: ~65 characters
|
- Prefix with `fix:`, `feat:`, `docs:`, or `chore:`
|
||||||
- Keep first line concise and descriptive
|
- Keep messages concise (average ~56 characters)
|
||||||
- Use imperative mood ("Add feature" not "Added feature")
|
```
|
||||||
|
feat: add support for new install target
|
||||||
|
fix: resolve agent prompt parsing bug
|
||||||
|
```
|
||||||
|
|
||||||
|
## Workflows
|
||||||
|
|
||||||
*Commit message example*
|
### Add or Update a Skill
|
||||||
|
|
||||||
```text
|
**Trigger:** When introducing or updating a skill for agentic workflows
|
||||||
feat(rules): add C# language support
|
**Command:** `/add-skill`
|
||||||
|
|
||||||
|
1. Create or update a `SKILL.md` file under `skills/{skill-name}/` or `.agents/skills/{skill-name}/`.
|
||||||
|
2. Optionally update `AGENTS.md`, `README.md`, and localized docs (e.g., `README.zh-CN.md`).
|
||||||
|
3. Update `manifests/install-modules.json` and/or `install-components.json` if the skill is installable.
|
||||||
|
4. Optionally add or update related agent markdown files.
|
||||||
|
5. Optionally update tests or scripts if the skill introduces new hooks or behaviors.
|
||||||
|
|
||||||
|
**Example:**
|
||||||
|
```shell
|
||||||
|
mkdir -p skills/myNewSkill
|
||||||
|
touch skills/myNewSkill/SKILL.md
|
||||||
|
# Edit SKILL.md with documentation
|
||||||
```
|
```
|
||||||
|
|
||||||
*Commit message example*
|
|
||||||
|
|
||||||
```text
|
|
||||||
chore(deps-dev): bump flatted (#675)
|
|
||||||
```
|
|
||||||
|
|
||||||
*Commit message example*
|
|
||||||
|
|
||||||
```text
|
|
||||||
fix: auto-detect ECC root from plugin cache when CLAUDE_PLUGIN_ROOT is unset (#547) (#691)
|
|
||||||
```
|
|
||||||
|
|
||||||
*Commit message example*
|
|
||||||
|
|
||||||
```text
|
|
||||||
docs: add Antigravity setup and usage guide (#552)
|
|
||||||
```
|
|
||||||
|
|
||||||
*Commit message example*
|
|
||||||
|
|
||||||
```text
|
|
||||||
merge: PR #529 — feat(skills): add documentation-lookup, bun-runtime, nextjs-turbopack; feat(agents): add rust-reviewer
|
|
||||||
```
|
|
||||||
|
|
||||||
*Commit message example*
|
|
||||||
|
|
||||||
```text
|
|
||||||
Revert "Add Kiro IDE support (.kiro/) (#548)"
|
|
||||||
```
|
|
||||||
|
|
||||||
*Commit message example*
|
|
||||||
|
|
||||||
```text
|
|
||||||
Add Kiro IDE support (.kiro/) (#548)
|
|
||||||
```
|
|
||||||
|
|
||||||
*Commit message example*
|
|
||||||
|
|
||||||
```text
|
|
||||||
feat: add block-no-verify hook for Claude Code and Cursor (#649)
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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.
|
|
||||||
|
|
||||||
### Database Migration
|
|
||||||
|
|
||||||
Database schema changes with migration files
|
|
||||||
|
|
||||||
**Frequency**: ~2 times per month
|
|
||||||
|
|
||||||
**Steps**:
|
|
||||||
1. Create migration file
|
|
||||||
2. Update schema definitions
|
|
||||||
3. Generate/update types
|
|
||||||
|
|
||||||
**Files typically involved**:
|
|
||||||
- `**/schema.*`
|
|
||||||
- `migrations/*`
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
|
||||||
```
|
|
||||||
feat: implement --with/--without selective install flags (#679)
|
|
||||||
fix: sync catalog counts with filesystem (27 agents, 113 skills, 58 commands) (#693)
|
|
||||||
feat(rules): add Rust language rules (rebased #660) (#686)
|
|
||||||
```
|
|
||||||
|
|
||||||
### Feature Development
|
|
||||||
|
|
||||||
Standard feature implementation workflow
|
|
||||||
|
|
||||||
**Frequency**: ~22 times per month
|
|
||||||
|
|
||||||
**Steps**:
|
|
||||||
1. Add feature implementation
|
|
||||||
2. Add tests for feature
|
|
||||||
3. Update documentation
|
|
||||||
|
|
||||||
**Files typically involved**:
|
|
||||||
- `manifests/*`
|
|
||||||
- `schemas/*`
|
|
||||||
- `**/*.test.*`
|
|
||||||
- `**/api/**`
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
|
||||||
```
|
|
||||||
feat(skills): add documentation-lookup, bun-runtime, nextjs-turbopack; feat(agents): add rust-reviewer
|
|
||||||
docs(skills): align documentation-lookup with CONTRIBUTING template; add cross-harness (Codex/Cursor) skill copies
|
|
||||||
fix: address PR review — skill template (When to use, How it works, Examples), bun.lock, next build note, rust-reviewer CI note, doc-lookup privacy/uncertainty
|
|
||||||
```
|
|
||||||
|
|
||||||
### Add Language Rules
|
|
||||||
|
|
||||||
Adds a new programming language to the rules system, including coding style, hooks, patterns, security, and testing guidelines.
|
|
||||||
|
|
||||||
**Frequency**: ~2 times per month
|
|
||||||
|
|
||||||
**Steps**:
|
|
||||||
1. Create a new directory under rules/{language}/
|
|
||||||
2. Add coding-style.md, hooks.md, patterns.md, security.md, and testing.md files with language-specific content
|
|
||||||
3. Optionally reference or link to related skills
|
|
||||||
|
|
||||||
**Files typically involved**:
|
|
||||||
- `rules/*/coding-style.md`
|
|
||||||
- `rules/*/hooks.md`
|
|
||||||
- `rules/*/patterns.md`
|
|
||||||
- `rules/*/security.md`
|
|
||||||
- `rules/*/testing.md`
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
|
||||||
```
|
|
||||||
Create a new directory under rules/{language}/
|
|
||||||
Add coding-style.md, hooks.md, patterns.md, security.md, and testing.md files with language-specific content
|
|
||||||
Optionally reference or link to related skills
|
|
||||||
```
|
|
||||||
|
|
||||||
### Add New Skill
|
|
||||||
|
|
||||||
Adds a new skill to the system, documenting its workflow, triggers, and usage, often with supporting scripts.
|
|
||||||
|
|
||||||
**Frequency**: ~4 times per month
|
|
||||||
|
|
||||||
**Steps**:
|
|
||||||
1. Create a new directory under skills/{skill-name}/
|
|
||||||
2. Add SKILL.md with documentation (When to Use, How It Works, Examples, etc.)
|
|
||||||
3. Optionally add scripts or supporting files under skills/{skill-name}/scripts/
|
|
||||||
4. Address review feedback and iterate on documentation
|
|
||||||
|
|
||||||
**Files typically involved**:
|
|
||||||
- `skills/*/SKILL.md`
|
|
||||||
- `skills/*/scripts/*.sh`
|
|
||||||
- `skills/*/scripts/*.js`
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
|
||||||
```
|
|
||||||
Create a new directory under skills/{skill-name}/
|
|
||||||
Add SKILL.md with documentation (When to Use, How It Works, Examples, etc.)
|
|
||||||
Optionally add scripts or supporting files under skills/{skill-name}/scripts/
|
|
||||||
Address review feedback and iterate on documentation
|
|
||||||
```
|
|
||||||
|
|
||||||
### Add New Agent
|
|
||||||
|
|
||||||
Adds a new agent to the system for code review, build resolution, or other automated tasks.
|
|
||||||
|
|
||||||
**Frequency**: ~2 times per month
|
|
||||||
|
|
||||||
**Steps**:
|
|
||||||
1. Create a new agent markdown file under agents/{agent-name}.md
|
|
||||||
2. Register the agent in AGENTS.md
|
|
||||||
3. Optionally update README.md and docs/COMMAND-AGENT-MAP.md
|
|
||||||
|
|
||||||
**Files typically involved**:
|
|
||||||
- `agents/*.md`
|
|
||||||
- `AGENTS.md`
|
|
||||||
- `README.md`
|
|
||||||
- `docs/COMMAND-AGENT-MAP.md`
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
|
||||||
```
|
|
||||||
Create a new agent markdown file under agents/{agent-name}.md
|
|
||||||
Register the agent in AGENTS.md
|
|
||||||
Optionally update README.md and docs/COMMAND-AGENT-MAP.md
|
|
||||||
```
|
|
||||||
|
|
||||||
### Add New Command
|
|
||||||
|
|
||||||
Adds a new command to the system, often paired with a backing skill.
|
|
||||||
|
|
||||||
**Frequency**: ~1 times per month
|
|
||||||
|
|
||||||
**Steps**:
|
|
||||||
1. Create a new markdown file under commands/{command-name}.md
|
|
||||||
2. Optionally add or update a backing skill under skills/{skill-name}/SKILL.md
|
|
||||||
|
|
||||||
**Files typically involved**:
|
|
||||||
- `commands/*.md`
|
|
||||||
- `skills/*/SKILL.md`
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
|
||||||
```
|
|
||||||
Create a new markdown file under commands/{command-name}.md
|
|
||||||
Optionally add or update a backing skill under skills/{skill-name}/SKILL.md
|
|
||||||
```
|
|
||||||
|
|
||||||
### Sync Catalog Counts
|
|
||||||
|
|
||||||
Synchronizes the documented counts of agents, skills, and commands in AGENTS.md and README.md with the actual repository state.
|
|
||||||
|
|
||||||
**Frequency**: ~3 times per month
|
|
||||||
|
|
||||||
**Steps**:
|
|
||||||
1. Update agent, skill, and command counts in AGENTS.md
|
|
||||||
2. Update the same counts in README.md (quick-start, comparison table, etc.)
|
|
||||||
3. Optionally update other documentation files
|
|
||||||
|
|
||||||
**Files typically involved**:
|
|
||||||
- `AGENTS.md`
|
|
||||||
- `README.md`
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
|
||||||
```
|
|
||||||
Update agent, skill, and command counts in AGENTS.md
|
|
||||||
Update the same counts in README.md (quick-start, comparison table, etc.)
|
|
||||||
Optionally update other documentation files
|
|
||||||
```
|
|
||||||
|
|
||||||
### Add Cross Harness Skill Copies
|
|
||||||
|
|
||||||
Adds skill copies for different agent harnesses (e.g., Codex, Cursor, Antigravity) to ensure compatibility across platforms.
|
|
||||||
|
|
||||||
**Frequency**: ~2 times per month
|
|
||||||
|
|
||||||
**Steps**:
|
|
||||||
1. Copy or adapt SKILL.md to .agents/skills/{skill}/SKILL.md and/or .cursor/skills/{skill}/SKILL.md
|
|
||||||
2. Optionally add harness-specific openai.yaml or config files
|
|
||||||
3. Address review feedback to align with CONTRIBUTING template
|
|
||||||
|
|
||||||
**Files typically involved**:
|
|
||||||
- `.agents/skills/*/SKILL.md`
|
|
||||||
- `.cursor/skills/*/SKILL.md`
|
|
||||||
- `.agents/skills/*/agents/openai.yaml`
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
|
||||||
```
|
|
||||||
Copy or adapt SKILL.md to .agents/skills/{skill}/SKILL.md and/or .cursor/skills/{skill}/SKILL.md
|
|
||||||
Optionally add harness-specific openai.yaml or config files
|
|
||||||
Address review feedback to align with CONTRIBUTING template
|
|
||||||
```
|
|
||||||
|
|
||||||
### Add Or Update Hook
|
|
||||||
|
|
||||||
Adds or updates git or bash hooks to enforce workflow, quality, or security policies.
|
|
||||||
|
|
||||||
**Frequency**: ~1 times per month
|
|
||||||
|
|
||||||
**Steps**:
|
|
||||||
1. Add or update hook scripts in hooks/ or scripts/hooks/
|
|
||||||
2. Register the hook in hooks/hooks.json or similar config
|
|
||||||
3. Optionally add or update tests in tests/hooks/
|
|
||||||
|
|
||||||
**Files typically involved**:
|
|
||||||
- `hooks/*.hook`
|
|
||||||
- `hooks/hooks.json`
|
|
||||||
- `scripts/hooks/*.js`
|
|
||||||
- `tests/hooks/*.test.js`
|
|
||||||
- `.cursor/hooks.json`
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
|
||||||
```
|
|
||||||
Add or update hook scripts in hooks/ or scripts/hooks/
|
|
||||||
Register the hook in hooks/hooks.json or similar config
|
|
||||||
Optionally add or update tests in tests/hooks/
|
|
||||||
```
|
|
||||||
|
|
||||||
### Address Review Feedback
|
|
||||||
|
|
||||||
Addresses code review feedback by updating documentation, scripts, or configuration for clarity, correctness, or convention alignment.
|
|
||||||
|
|
||||||
**Frequency**: ~4 times per month
|
|
||||||
|
|
||||||
**Steps**:
|
|
||||||
1. Edit SKILL.md, agent, or command files to address reviewer comments
|
|
||||||
2. Update examples, headings, or configuration as requested
|
|
||||||
3. Iterate until all review feedback is resolved
|
|
||||||
|
|
||||||
**Files typically involved**:
|
|
||||||
- `skills/*/SKILL.md`
|
|
||||||
- `agents/*.md`
|
|
||||||
- `commands/*.md`
|
|
||||||
- `.agents/skills/*/SKILL.md`
|
|
||||||
- `.cursor/skills/*/SKILL.md`
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
|
||||||
```
|
|
||||||
Edit SKILL.md, agent, or command files to address reviewer comments
|
|
||||||
Update examples, headings, or configuration as requested
|
|
||||||
Iterate until all review feedback is resolved
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## 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 adding or updating a repeatable workflow command
|
||||||
|
**Command:** `/add-command`
|
||||||
|
|
||||||
|
1. Create or update a markdown file in `commands/` (e.g., `prp-*.md`, `gan-*.md`, `santa-loop.md`).
|
||||||
|
2. Document workflow phases, usage, and outputs in the file.
|
||||||
|
3. Optionally update related skills or agent definitions.
|
||||||
|
4. Optionally add shell scripts or orchestrators if automation is needed.
|
||||||
|
5. Optionally update `AGENTS.md` or `README.md` to reference the new command.
|
||||||
|
|
||||||
|
**Example:**
|
||||||
|
```shell
|
||||||
|
touch commands/prp-myworkflow.md
|
||||||
|
# Document the workflow steps in markdown
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Add or Update an Install Target
|
||||||
|
|
||||||
|
**Trigger:** When supporting a new IDE/platform or updating install logic
|
||||||
|
**Command:** `/add-install-target`
|
||||||
|
|
||||||
|
1. Add or update install scripts (`install.sh`, `install.js`, `uninstall.sh`, `uninstall.js`) in a new or existing directory (e.g., `.codebuddy/`).
|
||||||
|
2. Update `manifests/install-modules.json` and `schemas/ecc-install-config.schema.json`.
|
||||||
|
3. Update `scripts/lib/install-manifests.js` and `scripts/lib/install-targets/{target}.js`.
|
||||||
|
4. Add or update tests for install targets.
|
||||||
|
5. Optionally update `README.md` or `AGENTS.md`.
|
||||||
|
|
||||||
|
**Example:**
|
||||||
|
```shell
|
||||||
|
mkdir -p .codebuddy
|
||||||
|
touch .codebuddy/install.sh
|
||||||
|
# Implement install logic
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Update Hooks and Hook Tests
|
||||||
|
|
||||||
|
**Trigger:** When refactoring, fixing, or extending system hooks
|
||||||
|
**Command:** `/update-hook`
|
||||||
|
|
||||||
|
1. Edit `hooks/hooks.json` to change configuration or add/remove hooks.
|
||||||
|
2. Edit or add `scripts/hooks/*.js` to implement hook logic.
|
||||||
|
3. Edit or add `tests/hooks/*.test.js` to cover new or changed behaviors.
|
||||||
|
4. Optionally update related scripts or documentation.
|
||||||
|
|
||||||
|
**Example:**
|
||||||
|
```json
|
||||||
|
// hooks/hooks.json
|
||||||
|
{
|
||||||
|
"pre-commit": ["format", "typecheck"]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Dependency Bump via Dependabot
|
||||||
|
|
||||||
|
**Trigger:** When updating dependencies for security or features
|
||||||
|
**Command:** `/bump-dependency`
|
||||||
|
|
||||||
|
1. Update dependency version in `package.json`, `yarn.lock`, or workflow YAML files.
|
||||||
|
2. Commit with a standardized message (often by dependabot).
|
||||||
|
3. Optionally update related documentation or changelogs.
|
||||||
|
|
||||||
|
**Example:**
|
||||||
|
```json
|
||||||
|
// package.json
|
||||||
|
"dependencies": {
|
||||||
|
"some-lib": "^2.0.0"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Add or Update Agent Definition
|
||||||
|
|
||||||
|
**Trigger:** When adding or modifying agent definitions/prompts
|
||||||
|
**Command:** `/add-agent`
|
||||||
|
|
||||||
|
1. Add or update agent markdown files (`agents/*.md`).
|
||||||
|
2. Add or update prompt files (`.opencode/prompts/agents/*.txt`).
|
||||||
|
3. Update `.opencode/opencode.json` to register new agents.
|
||||||
|
4. Update `AGENTS.md` to document new agents.
|
||||||
|
5. Optionally update related skills or orchestrators.
|
||||||
|
|
||||||
|
**Example:**
|
||||||
|
```shell
|
||||||
|
touch agents/myAgent.md
|
||||||
|
touch .opencode/prompts/agents/myAgent.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
## Testing Patterns
|
||||||
|
|
||||||
|
- Test files follow the pattern `*.test.js`.
|
||||||
|
- Testing framework is **unknown** (not detected), but test files are placed alongside code or in `tests/` directories.
|
||||||
|
- Example test file:
|
||||||
|
```js
|
||||||
|
// tests/hooks/formatHook.test.js
|
||||||
|
const formatHook = require('../../scripts/hooks/formatHook');
|
||||||
|
test('should format code correctly', () => {
|
||||||
|
// test implementation
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
| Command | Purpose |
|
||||||
|
|--------------------|----------------------------------------------------------------|
|
||||||
|
| /add-skill | Add or update a skill and its documentation |
|
||||||
|
| /add-command | Add or update a workflow command |
|
||||||
|
| /add-install-target| Add or update an install target (IDE/platform/environment) |
|
||||||
|
| /update-hook | Refactor, fix, or extend system hooks and their tests |
|
||||||
|
| /bump-dependency | Update dependency versions in package or workflow files |
|
||||||
|
| /add-agent | Add or update agent definitions and prompts |
|
||||||
|
```
|
||||||
|
|||||||
@@ -7,9 +7,9 @@
|
|||||||
".agents/skills/everything-claude-code/SKILL.md"
|
".agents/skills/everything-claude-code/SKILL.md"
|
||||||
],
|
],
|
||||||
"commandFiles": [
|
"commandFiles": [
|
||||||
".claude/commands/database-migration.md",
|
|
||||||
".claude/commands/feature-development.md",
|
".claude/commands/feature-development.md",
|
||||||
".claude/commands/add-language-rules.md"
|
".claude/commands/refactoring.md",
|
||||||
|
".claude/commands/add-or-update-skill.md"
|
||||||
],
|
],
|
||||||
"updatedAt": "2026-03-20T12:07:36.496Z"
|
"updatedAt": "2026-04-01T23:05:46.781Z"
|
||||||
}
|
}
|
||||||
Reference in New Issue
Block a user