mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-04-02 07:03:28 +08:00
Compare commits
15 Commits
ecc-tools/
...
ecc-tools/
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
179d1e4ca5 | ||
|
|
db49085cb1 | ||
|
|
e044007d29 | ||
|
|
6abc110793 | ||
|
|
f0ed07ed82 | ||
|
|
a90b855d4d | ||
|
|
1c53accde5 | ||
|
|
64684a64e6 | ||
|
|
fe50d68257 | ||
|
|
306b48245f | ||
|
|
8f058ea0c5 | ||
|
|
b781af2d4d | ||
|
|
ea96178ac1 | ||
|
|
0e63bb37de | ||
|
|
03dfdd2fa0 |
@@ -1,166 +1,403 @@
|
||||
```markdown
|
||||
# everything-claude-code Development Patterns
|
||||
---
|
||||
name: everything-claude-code-conventions
|
||||
description: Development conventions and patterns for everything-claude-code. JavaScript project with conventional commits.
|
||||
---
|
||||
|
||||
> Auto-generated skill from repository analysis
|
||||
# Everything Claude Code Conventions
|
||||
|
||||
> Generated from [affaan-m/everything-claude-code](https://github.com/affaan-m/everything-claude-code) on 2026-04-01
|
||||
|
||||
## Overview
|
||||
|
||||
This skill introduces the core development patterns, coding conventions, and common workflows for contributing to the `everything-claude-code` repository. The project is JavaScript-based, with no framework dependencies, and emphasizes modularity, agentic skills, and workflow automation. This guide covers file organization, commit conventions, code style, workflow steps, and testing patterns to help you contribute effectively and consistently.
|
||||
This skill teaches Claude the development patterns and conventions used in everything-claude-code.
|
||||
|
||||
## Coding Conventions
|
||||
## Tech Stack
|
||||
|
||||
- **File Naming:** Use camelCase for JavaScript files and folders.
|
||||
- Example: `mySkill.js`, `installTarget.js`
|
||||
- **Import Style:** Use relative imports.
|
||||
- Example:
|
||||
```js
|
||||
const helper = require('./utils/helper');
|
||||
```
|
||||
- **Export Style:** Mixed (both CommonJS and ES module styles may be present).
|
||||
- Example (CommonJS):
|
||||
```js
|
||||
module.exports = function mySkill() { ... };
|
||||
```
|
||||
- Example (ESM):
|
||||
```js
|
||||
export default function mySkill() { ... }
|
||||
```
|
||||
- **Commit Messages:** Follow [Conventional Commits](https://www.conventionalcommits.org/) with prefixes such as `fix`, `feat`, `docs`, `chore`.
|
||||
- Example: `feat: add support for new install target`
|
||||
- **Test Files:** Use the pattern `*.test.js` for test files.
|
||||
- **Primary Language**: JavaScript
|
||||
- **Architecture**: hybrid module organization
|
||||
- **Test Location**: separate
|
||||
|
||||
## Workflows
|
||||
## When to Use This Skill
|
||||
|
||||
### Add or Update a Skill
|
||||
**Trigger:** When introducing or updating a workflow, agent, or capability
|
||||
**Command:** `/add-skill`
|
||||
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
|
||||
|
||||
1. Create or update a `SKILL.md` file in one of:
|
||||
- `skills/<skill-name>/SKILL.md`
|
||||
- `.agents/skills/<skill-name>/SKILL.md`
|
||||
- `.claude/skills/<skill-name>/SKILL.md`
|
||||
2. Optionally update `AGENTS.md`, `README.md`, or `manifests/install-modules.json` to reference the new skill.
|
||||
3. Document the skill's usage and integration points.
|
||||
## Commit Conventions
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/add-skill
|
||||
Follow these commit message conventions based on 500 analyzed commits.
|
||||
|
||||
### Commit Style: Conventional Commits
|
||||
|
||||
### Prefixes Used
|
||||
|
||||
- `fix`
|
||||
- `feat`
|
||||
- `docs`
|
||||
- `chore`
|
||||
|
||||
### Message Guidelines
|
||||
|
||||
- Average message length: ~57 characters
|
||||
- Keep first line concise and descriptive
|
||||
- Use imperative mood ("Add feature" not "Added feature")
|
||||
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code ECC bundle (.claude/commands/add-new-skill.md)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
refactor: collapse legacy command bodies into skills
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix: dedupe managed hooks by semantic identity
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
docs: close bundle drift and sync plugin guidance
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
chore: ignore local orchestration artifacts
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code ECC bundle (.claude/commands/refactoring.md)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code ECC bundle (.claude/commands/feature-development.md)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code ECC bundle (.claude/enterprise/controls.md)
|
||||
```
|
||||
|
||||
## Architecture
|
||||
|
||||
### Project Structure: Single Package
|
||||
|
||||
This project uses **hybrid** module organization.
|
||||
|
||||
### Configuration Files
|
||||
|
||||
- `.github/workflows/ci.yml`
|
||||
- `.github/workflows/maintenance.yml`
|
||||
- `.github/workflows/monthly-metrics.yml`
|
||||
- `.github/workflows/release.yml`
|
||||
- `.github/workflows/reusable-release.yml`
|
||||
- `.github/workflows/reusable-test.yml`
|
||||
- `.github/workflows/reusable-validate.yml`
|
||||
- `.opencode/package.json`
|
||||
- `.opencode/tsconfig.json`
|
||||
- `.prettierrc`
|
||||
- `eslint.config.js`
|
||||
- `package.json`
|
||||
|
||||
### Guidelines
|
||||
|
||||
- This project uses a hybrid organization
|
||||
- Follow existing patterns when adding new code
|
||||
|
||||
## Code Style
|
||||
|
||||
### Language: JavaScript
|
||||
|
||||
### Naming Conventions
|
||||
|
||||
| Element | Convention |
|
||||
|---------|------------|
|
||||
| Files | camelCase |
|
||||
| Functions | camelCase |
|
||||
| Classes | PascalCase |
|
||||
| Constants | SCREAMING_SNAKE_CASE |
|
||||
|
||||
### Import Style: Relative Imports
|
||||
|
||||
### Export Style: Mixed Style
|
||||
|
||||
|
||||
*Preferred import style*
|
||||
|
||||
```typescript
|
||||
// Use relative imports
|
||||
import { Button } from '../components/Button'
|
||||
import { useAuth } from './hooks/useAuth'
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
### Test Framework
|
||||
|
||||
No specific test framework detected — use the repository's existing test patterns.
|
||||
|
||||
### File Pattern: `*.test.js`
|
||||
|
||||
### Test Types
|
||||
|
||||
- **Unit tests**: Test individual functions and components in isolation
|
||||
- **Integration tests**: Test interactions between multiple components/services
|
||||
|
||||
### Coverage
|
||||
|
||||
This project has coverage reporting configured. Aim for 80%+ coverage.
|
||||
|
||||
|
||||
## Error Handling
|
||||
|
||||
### Error Handling Style: Try-Catch Blocks
|
||||
|
||||
|
||||
*Standard error handling pattern*
|
||||
|
||||
```typescript
|
||||
try {
|
||||
const result = await riskyOperation()
|
||||
return result
|
||||
} catch (error) {
|
||||
console.error('Operation failed:', error)
|
||||
throw new Error('User-friendly message')
|
||||
}
|
||||
```
|
||||
|
||||
## Common Workflows
|
||||
|
||||
These workflows were detected from analyzing commit patterns.
|
||||
|
||||
### Feature Development
|
||||
|
||||
Standard feature implementation workflow
|
||||
|
||||
**Frequency**: ~19 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add feature implementation
|
||||
2. Add tests for feature
|
||||
3. Update documentation
|
||||
|
||||
**Files typically involved**:
|
||||
- `.opencode/*`
|
||||
- `.opencode/plugins/*`
|
||||
- `.opencode/plugins/lib/*`
|
||||
- `**/*.test.*`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
feat: install claude-hud plugin (jarrodwatts/claude-hud) (#1041)
|
||||
feat: add GAN-style generator-evaluator harness (#1029)
|
||||
feat(agents,skills): add opensource-pipeline — 3-agent workflow for safe public releases (#1036)
|
||||
```
|
||||
|
||||
### Refactoring
|
||||
|
||||
Code refactoring and cleanup workflow
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Ensure tests pass before refactor
|
||||
2. Refactor code structure
|
||||
3. Verify tests still pass
|
||||
|
||||
**Files typically involved**:
|
||||
- `src/**/*`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
refactor: collapse legacy command bodies into skills
|
||||
feat: add connected operator workflow skills
|
||||
feat: expand lead intelligence outreach channels
|
||||
```
|
||||
|
||||
### Add New Skill
|
||||
|
||||
Adds a new skill to the repository, enabling new agent capabilities or workflows.
|
||||
|
||||
**Frequency**: ~4 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create a new SKILL.md file under skills/ or .agents/skills/ or .claude/skills/
|
||||
2. Optionally update documentation (AGENTS.md, README.md, WORKING-CONTEXT.md)
|
||||
3. Optionally add supporting files (e.g., manifests/install-modules.json)
|
||||
|
||||
**Files typically involved**:
|
||||
- `skills/*/SKILL.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `.claude/skills/*/SKILL.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create a new SKILL.md file under skills/ or .agents/skills/ or .claude/skills/
|
||||
Optionally update documentation (AGENTS.md, README.md, WORKING-CONTEXT.md)
|
||||
Optionally add supporting files (e.g., manifests/install-modules.json)
|
||||
```
|
||||
|
||||
### Add Or Update Agent
|
||||
|
||||
Adds or updates agent definitions and registers them in configuration files.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add or update agent definition file (e.g., agents/*.md or .opencode/prompts/agents/*.txt)
|
||||
2. Update agent registry/configuration (e.g., .opencode/opencode.json, AGENTS.md)
|
||||
|
||||
**Files typically involved**:
|
||||
- `agents/*.md`
|
||||
- `.opencode/prompts/agents/*.txt`
|
||||
- `.opencode/opencode.json`
|
||||
- `AGENTS.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Add or update agent definition file (e.g., agents/*.md or .opencode/prompts/agents/*.txt)
|
||||
Update agent registry/configuration (e.g., .opencode/opencode.json, AGENTS.md)
|
||||
```
|
||||
|
||||
### Add Or Update Command
|
||||
|
||||
Adds or updates command workflow files for agentic operations.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or update command markdown file under commands/
|
||||
2. Optionally update documentation or index files
|
||||
|
||||
**Files typically involved**:
|
||||
- `commands/*.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or update command markdown file under commands/
|
||||
Optionally update documentation or index files
|
||||
```
|
||||
|
||||
### Feature Or Skill Bundle
|
||||
|
||||
Adds a bundle of related features, skills, and documentation for a new workflow or capability.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add multiple agent and/or skill files
|
||||
2. Add supporting commands and scripts
|
||||
3. Add or update documentation and examples
|
||||
|
||||
**Files typically involved**:
|
||||
- `agents/*.md`
|
||||
- `skills/*/SKILL.md`
|
||||
- `commands/*.md`
|
||||
- `scripts/*.sh`
|
||||
- `examples/*`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Add multiple agent and/or skill files
|
||||
Add supporting commands and scripts
|
||||
Add or update documentation and examples
|
||||
```
|
||||
|
||||
### Documentation Update
|
||||
|
||||
Updates documentation to reflect new features, workflows, or guidance.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit documentation files (README.md, AGENTS.md, WORKING-CONTEXT.md, docs/...)
|
||||
2. Optionally update or add new guidance files
|
||||
|
||||
**Files typically involved**:
|
||||
- `README.md`
|
||||
- `AGENTS.md`
|
||||
- `WORKING-CONTEXT.md`
|
||||
- `docs/**/*.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit documentation files (README.md, AGENTS.md, WORKING-CONTEXT.md, docs/...)
|
||||
Optionally update or add new guidance files
|
||||
```
|
||||
|
||||
### Dependency Or Schema Update
|
||||
|
||||
Updates dependencies or schema files, often in response to new features or external updates.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit package.json, yarn.lock, or other lockfiles
|
||||
2. Edit schema files under schemas/
|
||||
3. Optionally update related scripts or manifests
|
||||
|
||||
**Files typically involved**:
|
||||
- `package.json`
|
||||
- `yarn.lock`
|
||||
- `schemas/*.json`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit package.json, yarn.lock, or other lockfiles
|
||||
Edit schema files under schemas/
|
||||
Optionally update related scripts or manifests
|
||||
```
|
||||
|
||||
### Ci Cd Workflow Update
|
||||
|
||||
Updates CI/CD workflow files, usually for dependency bumps or workflow improvements.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit workflow files under .github/workflows/
|
||||
|
||||
**Files typically involved**:
|
||||
- `.github/workflows/*.yml`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit workflow files under .github/workflows/
|
||||
```
|
||||
|
||||
|
||||
## 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
|
||||
|
||||
---
|
||||
|
||||
### Add or Update a Command
|
||||
**Trigger:** When adding a new CLI command, workflow, or extending command capabilities
|
||||
**Command:** `/add-command`
|
||||
|
||||
1. Create or update a markdown file in `commands/` (e.g., `commands/<command>.md`).
|
||||
2. Optionally update related documentation (`README.md`, `AGENTS.md`).
|
||||
3. If the command is part of a workflow, update or create associated artifacts or scripts.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/add-command
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update an Agent
|
||||
**Trigger:** When introducing a new agent or updating agent logic
|
||||
**Command:** `/add-agent`
|
||||
|
||||
1. Create or update agent definition markdown in `agents/<agent-name>.md` or `.opencode/prompts/agents/<agent>.txt`.
|
||||
2. Register or update the agent in `opencode.json` or related config.
|
||||
3. Update `AGENTS.md` with new agent details.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/add-agent
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update an Install Target
|
||||
**Trigger:** When supporting a new platform/tool for installation/integration
|
||||
**Command:** `/add-install-target`
|
||||
|
||||
1. Create or update install scripts (`.sh`/`.js`) and documentation in a dot-directory (e.g., `.codebuddy/`, `.gemini/`).
|
||||
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.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/add-install-target
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update CI Workflow
|
||||
**Trigger:** When updating CI workflows, adding new checks, or bumping dependencies
|
||||
**Command:** `/update-ci`
|
||||
|
||||
1. Edit or add files in `.github/workflows/`.
|
||||
2. Update `package.json` or `yarn.lock` if dependency-related.
|
||||
3. Test CI to ensure the new workflow or dependency works as intended.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/update-ci
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Update Hooks or Validation Scripts
|
||||
**Trigger:** When improving or fixing pre/post hooks, or validation logic for edits and CI
|
||||
**Command:** `/update-hooks`
|
||||
|
||||
1. Edit `hooks/hooks.json` and supporting scripts in `scripts/hooks/`.
|
||||
2. Update or add tests in `tests/hooks/` or `tests/scripts/`.
|
||||
3. Optionally update related documentation.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/update-hooks
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update Documentation
|
||||
**Trigger:** When documenting new workflows, updating guides, or adding troubleshooting info
|
||||
**Command:** `/update-docs`
|
||||
|
||||
1. Edit or add markdown files in `docs/`, `WORKING-CONTEXT.md`, or `the-shortform-guide.md`.
|
||||
2. Update `README.md` and/or `README.zh-CN.md`.
|
||||
3. Optionally update related skill or agent docs.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/update-docs
|
||||
```
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
- **Test Files:** Place tests in the same directory as the code or in a `tests/` directory, using the `*.test.js` naming convention.
|
||||
- **Framework:** No specific testing framework detected; use standard JavaScript test runners (e.g., Jest, Mocha) as appropriate.
|
||||
- **Example Test File:**
|
||||
```js
|
||||
// mySkill.test.js
|
||||
const mySkill = require('./mySkill');
|
||||
|
||||
test('should return expected result', () => {
|
||||
expect(mySkill('input')).toBe('expected output');
|
||||
});
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Purpose |
|
||||
|---------------------|--------------------------------------------------------------|
|
||||
| /add-skill | Add or update a skill (workflow, agent, or capability) |
|
||||
| /add-command | Add or update a command file for new or extended workflows |
|
||||
| /add-agent | Add or update an agent definition |
|
||||
| /add-install-target | Add or update an install target for external integrations |
|
||||
| /update-ci | Add or update CI/CD workflow files or dependencies |
|
||||
| /update-hooks | Update hooks or validation scripts |
|
||||
| /update-docs | Add or update documentation |
|
||||
```
|
||||
*This skill was auto-generated by [ECC Tools](https://ecc.tools). Review and customize as needed for your team.*
|
||||
|
||||
37
.claude/commands/add-new-skill.md
Normal file
37
.claude/commands/add-new-skill.md
Normal file
@@ -0,0 +1,37 @@
|
||||
---
|
||||
name: add-new-skill
|
||||
description: Workflow command scaffold for add-new-skill in everything-claude-code.
|
||||
allowed_tools: ["Bash", "Read", "Write", "Grep", "Glob"]
|
||||
---
|
||||
|
||||
# /add-new-skill
|
||||
|
||||
Use this workflow when working on **add-new-skill** in `everything-claude-code`.
|
||||
|
||||
## Goal
|
||||
|
||||
Adds a new skill to the repository, enabling new agent capabilities or workflows.
|
||||
|
||||
## Common Files
|
||||
|
||||
- `skills/*/SKILL.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `.claude/skills/*/SKILL.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 under skills/ or .agents/skills/ or .claude/skills/
|
||||
- Optionally update documentation (AGENTS.md, README.md, WORKING-CONTEXT.md)
|
||||
- Optionally add supporting files (e.g., manifests/install-modules.json)
|
||||
|
||||
## Notes
|
||||
|
||||
- Treat this as a scaffold, not a hard-coded script.
|
||||
- Update the command if the workflow evolves materially.
|
||||
@@ -1,40 +0,0 @@
|
||||
---
|
||||
name: add-or-update-skill
|
||||
description: Workflow command scaffold for add-or-update-skill in everything-claude-code.
|
||||
allowed_tools: ["Bash", "Read", "Write", "Grep", "Glob"]
|
||||
---
|
||||
|
||||
# /add-or-update-skill
|
||||
|
||||
Use this workflow when working on **add-or-update-skill** in `everything-claude-code`.
|
||||
|
||||
## Goal
|
||||
|
||||
Adds a new skill or updates an existing skill, typically for a new workflow, agent, or capability.
|
||||
|
||||
## Common Files
|
||||
|
||||
- `skills/*/SKILL.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `.claude/skills/*/SKILL.md`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `manifests/install-modules.json`
|
||||
|
||||
## Suggested Sequence
|
||||
|
||||
1. Understand the current state and failure mode before editing.
|
||||
2. Make the smallest coherent change that satisfies the workflow goal.
|
||||
3. Run the most relevant verification for touched files.
|
||||
4. Summarize what changed and what still needs review.
|
||||
|
||||
## Typical Commit Signals
|
||||
|
||||
- Create or update a SKILL.md file in skills/<skill-name>/ or .agents/skills/<skill-name>/ or .claude/skills/<skill-name>/
|
||||
- Optionally update AGENTS.md, README.md, or manifests/install-modules.json to reference the new skill
|
||||
- Document the skill's usage and integration points
|
||||
|
||||
## 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-01T22:57:31.655Z",
|
||||
"generatedAt": "2026-04-01T22:44:14.561Z",
|
||||
"repo": "https://github.com/affaan-m/everything-claude-code",
|
||||
"profiles": {
|
||||
"requested": "full",
|
||||
@@ -150,7 +150,7 @@
|
||||
".claude/enterprise/controls.md",
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-or-update-skill.md"
|
||||
".claude/commands/add-new-skill.md"
|
||||
],
|
||||
"packageFiles": {
|
||||
"runtime-core": [
|
||||
@@ -180,7 +180,7 @@
|
||||
"workflow-pack": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-or-update-skill.md"
|
||||
".claude/commands/add-new-skill.md"
|
||||
]
|
||||
},
|
||||
"moduleFiles": {
|
||||
@@ -211,7 +211,7 @@
|
||||
"workflow-pack": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-or-update-skill.md"
|
||||
".claude/commands/add-new-skill.md"
|
||||
]
|
||||
},
|
||||
"files": [
|
||||
@@ -297,8 +297,8 @@
|
||||
},
|
||||
{
|
||||
"moduleId": "workflow-pack",
|
||||
"path": ".claude/commands/add-or-update-skill.md",
|
||||
"description": "Workflow command scaffold for add-or-update-skill."
|
||||
"path": ".claude/commands/add-new-skill.md",
|
||||
"description": "Workflow command scaffold for add-new-skill."
|
||||
}
|
||||
],
|
||||
"workflows": [
|
||||
@@ -311,8 +311,8 @@
|
||||
"path": ".claude/commands/refactoring.md"
|
||||
},
|
||||
{
|
||||
"command": "add-or-update-skill",
|
||||
"path": ".claude/commands/add-or-update-skill.md"
|
||||
"command": "add-new-skill",
|
||||
"path": ".claude/commands/add-new-skill.md"
|
||||
}
|
||||
],
|
||||
"adapters": {
|
||||
@@ -322,7 +322,7 @@
|
||||
"commandPaths": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-or-update-skill.md"
|
||||
".claude/commands/add-new-skill.md"
|
||||
]
|
||||
},
|
||||
"codex": {
|
||||
|
||||
@@ -10,5 +10,5 @@
|
||||
"javascript"
|
||||
],
|
||||
"suggestedBy": "ecc-tools-repo-analysis",
|
||||
"createdAt": "2026-04-01T22:58:08.299Z"
|
||||
"createdAt": "2026-04-01T22:51:05.478Z"
|
||||
}
|
||||
@@ -26,7 +26,7 @@ Generated by ECC Tools from repository history. Review before treating it as a h
|
||||
|
||||
- feature-development: Standard feature implementation workflow
|
||||
- refactoring: Code refactoring and cleanup workflow
|
||||
- add-or-update-skill: Adds a new skill or updates an existing skill, typically for a new workflow, agent, or capability.
|
||||
- add-new-skill: Adds a new skill to the repository, enabling new agent capabilities or workflows.
|
||||
|
||||
## Review Reminder
|
||||
|
||||
|
||||
@@ -1,166 +1,403 @@
|
||||
```markdown
|
||||
# everything-claude-code Development Patterns
|
||||
---
|
||||
name: everything-claude-code-conventions
|
||||
description: Development conventions and patterns for everything-claude-code. JavaScript project with conventional commits.
|
||||
---
|
||||
|
||||
> Auto-generated skill from repository analysis
|
||||
# Everything Claude Code Conventions
|
||||
|
||||
> Generated from [affaan-m/everything-claude-code](https://github.com/affaan-m/everything-claude-code) on 2026-04-01
|
||||
|
||||
## Overview
|
||||
|
||||
This skill introduces the core development patterns, coding conventions, and common workflows for contributing to the `everything-claude-code` repository. The project is JavaScript-based, with no framework dependencies, and emphasizes modularity, agentic skills, and workflow automation. This guide covers file organization, commit conventions, code style, workflow steps, and testing patterns to help you contribute effectively and consistently.
|
||||
This skill teaches Claude the development patterns and conventions used in everything-claude-code.
|
||||
|
||||
## Coding Conventions
|
||||
## Tech Stack
|
||||
|
||||
- **File Naming:** Use camelCase for JavaScript files and folders.
|
||||
- Example: `mySkill.js`, `installTarget.js`
|
||||
- **Import Style:** Use relative imports.
|
||||
- Example:
|
||||
```js
|
||||
const helper = require('./utils/helper');
|
||||
```
|
||||
- **Export Style:** Mixed (both CommonJS and ES module styles may be present).
|
||||
- Example (CommonJS):
|
||||
```js
|
||||
module.exports = function mySkill() { ... };
|
||||
```
|
||||
- Example (ESM):
|
||||
```js
|
||||
export default function mySkill() { ... }
|
||||
```
|
||||
- **Commit Messages:** Follow [Conventional Commits](https://www.conventionalcommits.org/) with prefixes such as `fix`, `feat`, `docs`, `chore`.
|
||||
- Example: `feat: add support for new install target`
|
||||
- **Test Files:** Use the pattern `*.test.js` for test files.
|
||||
- **Primary Language**: JavaScript
|
||||
- **Architecture**: hybrid module organization
|
||||
- **Test Location**: separate
|
||||
|
||||
## Workflows
|
||||
## When to Use This Skill
|
||||
|
||||
### Add or Update a Skill
|
||||
**Trigger:** When introducing or updating a workflow, agent, or capability
|
||||
**Command:** `/add-skill`
|
||||
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
|
||||
|
||||
1. Create or update a `SKILL.md` file in one of:
|
||||
- `skills/<skill-name>/SKILL.md`
|
||||
- `.agents/skills/<skill-name>/SKILL.md`
|
||||
- `.claude/skills/<skill-name>/SKILL.md`
|
||||
2. Optionally update `AGENTS.md`, `README.md`, or `manifests/install-modules.json` to reference the new skill.
|
||||
3. Document the skill's usage and integration points.
|
||||
## Commit Conventions
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/add-skill
|
||||
Follow these commit message conventions based on 500 analyzed commits.
|
||||
|
||||
### Commit Style: Conventional Commits
|
||||
|
||||
### Prefixes Used
|
||||
|
||||
- `fix`
|
||||
- `feat`
|
||||
- `docs`
|
||||
- `chore`
|
||||
|
||||
### Message Guidelines
|
||||
|
||||
- Average message length: ~57 characters
|
||||
- Keep first line concise and descriptive
|
||||
- Use imperative mood ("Add feature" not "Added feature")
|
||||
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code ECC bundle (.claude/commands/add-new-skill.md)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
refactor: collapse legacy command bodies into skills
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix: dedupe managed hooks by semantic identity
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
docs: close bundle drift and sync plugin guidance
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
chore: ignore local orchestration artifacts
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code ECC bundle (.claude/commands/refactoring.md)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code ECC bundle (.claude/commands/feature-development.md)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code ECC bundle (.claude/enterprise/controls.md)
|
||||
```
|
||||
|
||||
## Architecture
|
||||
|
||||
### Project Structure: Single Package
|
||||
|
||||
This project uses **hybrid** module organization.
|
||||
|
||||
### Configuration Files
|
||||
|
||||
- `.github/workflows/ci.yml`
|
||||
- `.github/workflows/maintenance.yml`
|
||||
- `.github/workflows/monthly-metrics.yml`
|
||||
- `.github/workflows/release.yml`
|
||||
- `.github/workflows/reusable-release.yml`
|
||||
- `.github/workflows/reusable-test.yml`
|
||||
- `.github/workflows/reusable-validate.yml`
|
||||
- `.opencode/package.json`
|
||||
- `.opencode/tsconfig.json`
|
||||
- `.prettierrc`
|
||||
- `eslint.config.js`
|
||||
- `package.json`
|
||||
|
||||
### Guidelines
|
||||
|
||||
- This project uses a hybrid organization
|
||||
- Follow existing patterns when adding new code
|
||||
|
||||
## Code Style
|
||||
|
||||
### Language: JavaScript
|
||||
|
||||
### Naming Conventions
|
||||
|
||||
| Element | Convention |
|
||||
|---------|------------|
|
||||
| Files | camelCase |
|
||||
| Functions | camelCase |
|
||||
| Classes | PascalCase |
|
||||
| Constants | SCREAMING_SNAKE_CASE |
|
||||
|
||||
### Import Style: Relative Imports
|
||||
|
||||
### Export Style: Mixed Style
|
||||
|
||||
|
||||
*Preferred import style*
|
||||
|
||||
```typescript
|
||||
// Use relative imports
|
||||
import { Button } from '../components/Button'
|
||||
import { useAuth } from './hooks/useAuth'
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
### Test Framework
|
||||
|
||||
No specific test framework detected — use the repository's existing test patterns.
|
||||
|
||||
### File Pattern: `*.test.js`
|
||||
|
||||
### Test Types
|
||||
|
||||
- **Unit tests**: Test individual functions and components in isolation
|
||||
- **Integration tests**: Test interactions between multiple components/services
|
||||
|
||||
### Coverage
|
||||
|
||||
This project has coverage reporting configured. Aim for 80%+ coverage.
|
||||
|
||||
|
||||
## Error Handling
|
||||
|
||||
### Error Handling Style: Try-Catch Blocks
|
||||
|
||||
|
||||
*Standard error handling pattern*
|
||||
|
||||
```typescript
|
||||
try {
|
||||
const result = await riskyOperation()
|
||||
return result
|
||||
} catch (error) {
|
||||
console.error('Operation failed:', error)
|
||||
throw new Error('User-friendly message')
|
||||
}
|
||||
```
|
||||
|
||||
## Common Workflows
|
||||
|
||||
These workflows were detected from analyzing commit patterns.
|
||||
|
||||
### Feature Development
|
||||
|
||||
Standard feature implementation workflow
|
||||
|
||||
**Frequency**: ~19 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add feature implementation
|
||||
2. Add tests for feature
|
||||
3. Update documentation
|
||||
|
||||
**Files typically involved**:
|
||||
- `.opencode/*`
|
||||
- `.opencode/plugins/*`
|
||||
- `.opencode/plugins/lib/*`
|
||||
- `**/*.test.*`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
feat: install claude-hud plugin (jarrodwatts/claude-hud) (#1041)
|
||||
feat: add GAN-style generator-evaluator harness (#1029)
|
||||
feat(agents,skills): add opensource-pipeline — 3-agent workflow for safe public releases (#1036)
|
||||
```
|
||||
|
||||
### Refactoring
|
||||
|
||||
Code refactoring and cleanup workflow
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Ensure tests pass before refactor
|
||||
2. Refactor code structure
|
||||
3. Verify tests still pass
|
||||
|
||||
**Files typically involved**:
|
||||
- `src/**/*`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
refactor: collapse legacy command bodies into skills
|
||||
feat: add connected operator workflow skills
|
||||
feat: expand lead intelligence outreach channels
|
||||
```
|
||||
|
||||
### Add New Skill
|
||||
|
||||
Adds a new skill to the repository, enabling new agent capabilities or workflows.
|
||||
|
||||
**Frequency**: ~4 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create a new SKILL.md file under skills/ or .agents/skills/ or .claude/skills/
|
||||
2. Optionally update documentation (AGENTS.md, README.md, WORKING-CONTEXT.md)
|
||||
3. Optionally add supporting files (e.g., manifests/install-modules.json)
|
||||
|
||||
**Files typically involved**:
|
||||
- `skills/*/SKILL.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `.claude/skills/*/SKILL.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create a new SKILL.md file under skills/ or .agents/skills/ or .claude/skills/
|
||||
Optionally update documentation (AGENTS.md, README.md, WORKING-CONTEXT.md)
|
||||
Optionally add supporting files (e.g., manifests/install-modules.json)
|
||||
```
|
||||
|
||||
### Add Or Update Agent
|
||||
|
||||
Adds or updates agent definitions and registers them in configuration files.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add or update agent definition file (e.g., agents/*.md or .opencode/prompts/agents/*.txt)
|
||||
2. Update agent registry/configuration (e.g., .opencode/opencode.json, AGENTS.md)
|
||||
|
||||
**Files typically involved**:
|
||||
- `agents/*.md`
|
||||
- `.opencode/prompts/agents/*.txt`
|
||||
- `.opencode/opencode.json`
|
||||
- `AGENTS.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Add or update agent definition file (e.g., agents/*.md or .opencode/prompts/agents/*.txt)
|
||||
Update agent registry/configuration (e.g., .opencode/opencode.json, AGENTS.md)
|
||||
```
|
||||
|
||||
### Add Or Update Command
|
||||
|
||||
Adds or updates command workflow files for agentic operations.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or update command markdown file under commands/
|
||||
2. Optionally update documentation or index files
|
||||
|
||||
**Files typically involved**:
|
||||
- `commands/*.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or update command markdown file under commands/
|
||||
Optionally update documentation or index files
|
||||
```
|
||||
|
||||
### Feature Or Skill Bundle
|
||||
|
||||
Adds a bundle of related features, skills, and documentation for a new workflow or capability.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add multiple agent and/or skill files
|
||||
2. Add supporting commands and scripts
|
||||
3. Add or update documentation and examples
|
||||
|
||||
**Files typically involved**:
|
||||
- `agents/*.md`
|
||||
- `skills/*/SKILL.md`
|
||||
- `commands/*.md`
|
||||
- `scripts/*.sh`
|
||||
- `examples/*`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Add multiple agent and/or skill files
|
||||
Add supporting commands and scripts
|
||||
Add or update documentation and examples
|
||||
```
|
||||
|
||||
### Documentation Update
|
||||
|
||||
Updates documentation to reflect new features, workflows, or guidance.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit documentation files (README.md, AGENTS.md, WORKING-CONTEXT.md, docs/...)
|
||||
2. Optionally update or add new guidance files
|
||||
|
||||
**Files typically involved**:
|
||||
- `README.md`
|
||||
- `AGENTS.md`
|
||||
- `WORKING-CONTEXT.md`
|
||||
- `docs/**/*.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit documentation files (README.md, AGENTS.md, WORKING-CONTEXT.md, docs/...)
|
||||
Optionally update or add new guidance files
|
||||
```
|
||||
|
||||
### Dependency Or Schema Update
|
||||
|
||||
Updates dependencies or schema files, often in response to new features or external updates.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit package.json, yarn.lock, or other lockfiles
|
||||
2. Edit schema files under schemas/
|
||||
3. Optionally update related scripts or manifests
|
||||
|
||||
**Files typically involved**:
|
||||
- `package.json`
|
||||
- `yarn.lock`
|
||||
- `schemas/*.json`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit package.json, yarn.lock, or other lockfiles
|
||||
Edit schema files under schemas/
|
||||
Optionally update related scripts or manifests
|
||||
```
|
||||
|
||||
### Ci Cd Workflow Update
|
||||
|
||||
Updates CI/CD workflow files, usually for dependency bumps or workflow improvements.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit workflow files under .github/workflows/
|
||||
|
||||
**Files typically involved**:
|
||||
- `.github/workflows/*.yml`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit workflow files under .github/workflows/
|
||||
```
|
||||
|
||||
|
||||
## 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
|
||||
|
||||
---
|
||||
|
||||
### Add or Update a Command
|
||||
**Trigger:** When adding a new CLI command, workflow, or extending command capabilities
|
||||
**Command:** `/add-command`
|
||||
|
||||
1. Create or update a markdown file in `commands/` (e.g., `commands/<command>.md`).
|
||||
2. Optionally update related documentation (`README.md`, `AGENTS.md`).
|
||||
3. If the command is part of a workflow, update or create associated artifacts or scripts.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/add-command
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update an Agent
|
||||
**Trigger:** When introducing a new agent or updating agent logic
|
||||
**Command:** `/add-agent`
|
||||
|
||||
1. Create or update agent definition markdown in `agents/<agent-name>.md` or `.opencode/prompts/agents/<agent>.txt`.
|
||||
2. Register or update the agent in `opencode.json` or related config.
|
||||
3. Update `AGENTS.md` with new agent details.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/add-agent
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update an Install Target
|
||||
**Trigger:** When supporting a new platform/tool for installation/integration
|
||||
**Command:** `/add-install-target`
|
||||
|
||||
1. Create or update install scripts (`.sh`/`.js`) and documentation in a dot-directory (e.g., `.codebuddy/`, `.gemini/`).
|
||||
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.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/add-install-target
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update CI Workflow
|
||||
**Trigger:** When updating CI workflows, adding new checks, or bumping dependencies
|
||||
**Command:** `/update-ci`
|
||||
|
||||
1. Edit or add files in `.github/workflows/`.
|
||||
2. Update `package.json` or `yarn.lock` if dependency-related.
|
||||
3. Test CI to ensure the new workflow or dependency works as intended.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/update-ci
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Update Hooks or Validation Scripts
|
||||
**Trigger:** When improving or fixing pre/post hooks, or validation logic for edits and CI
|
||||
**Command:** `/update-hooks`
|
||||
|
||||
1. Edit `hooks/hooks.json` and supporting scripts in `scripts/hooks/`.
|
||||
2. Update or add tests in `tests/hooks/` or `tests/scripts/`.
|
||||
3. Optionally update related documentation.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/update-hooks
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update Documentation
|
||||
**Trigger:** When documenting new workflows, updating guides, or adding troubleshooting info
|
||||
**Command:** `/update-docs`
|
||||
|
||||
1. Edit or add markdown files in `docs/`, `WORKING-CONTEXT.md`, or `the-shortform-guide.md`.
|
||||
2. Update `README.md` and/or `README.zh-CN.md`.
|
||||
3. Optionally update related skill or agent docs.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/update-docs
|
||||
```
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
- **Test Files:** Place tests in the same directory as the code or in a `tests/` directory, using the `*.test.js` naming convention.
|
||||
- **Framework:** No specific testing framework detected; use standard JavaScript test runners (e.g., Jest, Mocha) as appropriate.
|
||||
- **Example Test File:**
|
||||
```js
|
||||
// mySkill.test.js
|
||||
const mySkill = require('./mySkill');
|
||||
|
||||
test('should return expected result', () => {
|
||||
expect(mySkill('input')).toBe('expected output');
|
||||
});
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Purpose |
|
||||
|---------------------|--------------------------------------------------------------|
|
||||
| /add-skill | Add or update a skill (workflow, agent, or capability) |
|
||||
| /add-command | Add or update a command file for new or extended workflows |
|
||||
| /add-agent | Add or update an agent definition |
|
||||
| /add-install-target | Add or update an install target for external integrations |
|
||||
| /update-ci | Add or update CI/CD workflow files or dependencies |
|
||||
| /update-hooks | Update hooks or validation scripts |
|
||||
| /update-docs | Add or update documentation |
|
||||
```
|
||||
*This skill was auto-generated by [ECC Tools](https://ecc.tools). Review and customize as needed for your team.*
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
"commandFiles": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-or-update-skill.md"
|
||||
".claude/commands/add-new-skill.md"
|
||||
],
|
||||
"updatedAt": "2026-04-01T22:57:31.655Z"
|
||||
"updatedAt": "2026-04-01T22:44:14.561Z"
|
||||
}
|
||||
Reference in New Issue
Block a user