mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-04-02 15:13:28 +08:00
Compare commits
15 Commits
ecc-tools/
...
ecc-tools/
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
16c21dbc4c | ||
|
|
b384eba56a | ||
|
|
0dff4a2a0b | ||
|
|
974083e1fb | ||
|
|
ee70286227 | ||
|
|
766a295be3 | ||
|
|
31fcb5a12b | ||
|
|
d98df98645 | ||
|
|
43ee6a56ed | ||
|
|
fad829651e | ||
|
|
6d5fbac2d3 | ||
|
|
e4ddd5291e | ||
|
|
69c9ac390c | ||
|
|
29a8ce8665 | ||
|
|
b66ddcf5db |
@@ -1,403 +1,175 @@
|
||||
---
|
||||
name: everything-claude-code-conventions
|
||||
description: Development conventions and patterns for everything-claude-code. JavaScript project with conventional commits.
|
||||
---
|
||||
```markdown
|
||||
# everything-claude-code Development Patterns
|
||||
|
||||
# Everything Claude Code Conventions
|
||||
|
||||
> Generated from [affaan-m/everything-claude-code](https://github.com/affaan-m/everything-claude-code) on 2026-04-01
|
||||
> Auto-generated skill from repository analysis
|
||||
|
||||
## Overview
|
||||
|
||||
This skill teaches Claude the development patterns and conventions used in everything-claude-code.
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- **Primary Language**: JavaScript
|
||||
- **Architecture**: hybrid module organization
|
||||
- **Test Location**: separate
|
||||
|
||||
## When to Use This 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
|
||||
|
||||
## Commit Conventions
|
||||
|
||||
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
|
||||
```
|
||||
This skill teaches the core development patterns, coding conventions, and common workflows used in the `everything-claude-code` repository. The codebase is primarily JavaScript, with no major framework, and is organized around modular skills, agent definitions, command workflows, and extensible install targets. The repository emphasizes clear documentation, conventional commits, and maintainable architecture for agent and workflow development.
|
||||
|
||||
## Coding Conventions
|
||||
|
||||
- **File Naming:**
|
||||
Use `camelCase` for JavaScript files and directories.
|
||||
*Example:*
|
||||
```
|
||||
scripts/lib/installTargets.js
|
||||
agentPrompts.md
|
||||
```
|
||||
|
||||
- **Import Style:**
|
||||
Use **relative imports** for modules.
|
||||
*Example:*
|
||||
```js
|
||||
const installTarget = require('../lib/installTargets');
|
||||
```
|
||||
|
||||
- **Export Style:**
|
||||
Both CommonJS (`module.exports`) and ES module (`export`) styles are present.
|
||||
*Example (CommonJS):*
|
||||
```js
|
||||
module.exports = function mySkill() { ... };
|
||||
```
|
||||
*Example (ES Module):*
|
||||
```js
|
||||
export function mySkill() { ... }
|
||||
```
|
||||
|
||||
- **Commit Messages:**
|
||||
Use [Conventional Commits](https://www.conventionalcommits.org/).
|
||||
Prefixes: `fix`, `feat`, `docs`, `chore`
|
||||
*Example:*
|
||||
```
|
||||
feat: add Gemini install target support
|
||||
fix: correct agent prompt registration logic
|
||||
```
|
||||
|
||||
- **Documentation:**
|
||||
Each skill or agent should have a `SKILL.md` or `.md` documentation file explaining its purpose and usage.
|
||||
|
||||
## Workflows
|
||||
|
||||
### Add New Skill
|
||||
**Trigger:** When introducing a new skill for agents or workflows
|
||||
**Command:** `/add-skill`
|
||||
|
||||
Adds a new skill to the repository, enabling new agent capabilities or workflows.
|
||||
1. Create a new `SKILL.md` file under `skills/`, `.agents/skills/`, or `.claude/skills/`.
|
||||
2. Document the skill's purpose, usage, and configuration.
|
||||
3. Optionally update manifests or documentation if the skill is significant.
|
||||
|
||||
**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**:
|
||||
*Example:*
|
||||
```
|
||||
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)
|
||||
skills/myNewSkill/SKILL.md
|
||||
```
|
||||
|
||||
### 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
|
||||
|
||||
---
|
||||
|
||||
*This skill was auto-generated by [ECC Tools](https://ecc.tools). Review and customize as needed for your team.*
|
||||
### Add New Agent or Agent Prompt
|
||||
**Trigger:** When introducing a new agent persona or capability
|
||||
**Command:** `/add-agent`
|
||||
|
||||
1. Create a new agent definition (e.g., `agents/myAgent.md` or `.opencode/prompts/agents/myAgent.txt`).
|
||||
2. Register the agent in the relevant configuration file (e.g., `.opencode/opencode.json`).
|
||||
3. Update `AGENTS.md` or related documentation.
|
||||
|
||||
*Example:*
|
||||
```
|
||||
agents/supportAgent.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update Command Workflow
|
||||
**Trigger:** When introducing or improving a workflow command
|
||||
**Command:** `/add-command`
|
||||
|
||||
1. Create or update a command file under `commands/` (e.g., `commands/review.md`).
|
||||
2. Optionally update related documentation or scripts.
|
||||
3. Address review feedback and refine command logic.
|
||||
|
||||
---
|
||||
|
||||
### Add Install Target or Adapter
|
||||
**Trigger:** When supporting a new platform or integration
|
||||
**Command:** `/add-install-target`
|
||||
|
||||
1. Add new install scripts and documentation under a dot-directory (e.g., `.gemini/`, `.codebuddy/`).
|
||||
2. Update `manifests/install-modules.json` and relevant schema files.
|
||||
3. Implement or update `scripts/lib/install-targets/*.js` for the new target.
|
||||
4. Add or update tests for the install target.
|
||||
|
||||
*Example:*
|
||||
```
|
||||
.gemini/install.sh
|
||||
scripts/lib/install-targets/gemini.js
|
||||
tests/lib/install-targets.test.js
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Refactor or Collapse Commands to Skills
|
||||
**Trigger:** When modernizing command logic under the skills architecture
|
||||
**Command:** `/refactor-to-skill`
|
||||
|
||||
1. Update or remove `commands/*.md` files.
|
||||
2. Add or update `skills/*/SKILL.md` files.
|
||||
3. Update documentation (`README.md`, `AGENTS.md`, `WORKING-CONTEXT.md`, etc.).
|
||||
4. Update manifests if required.
|
||||
|
||||
---
|
||||
|
||||
### Documentation and Guidance Update
|
||||
**Trigger:** When clarifying, updating, or adding documentation
|
||||
**Command:** `/update-docs`
|
||||
|
||||
1. Edit or create documentation files (`README.md`, `WORKING-CONTEXT.md`, `docs/*.md`, etc.).
|
||||
2. Sync or update guidance in multiple language versions if needed.
|
||||
3. Optionally update related configuration or manifest files.
|
||||
|
||||
---
|
||||
|
||||
### CI/CD Workflow Update
|
||||
**Trigger:** When improving or fixing CI/CD processes
|
||||
**Command:** `/update-ci`
|
||||
|
||||
1. Edit `.github/workflows/*.yml` files.
|
||||
2. Update lockfiles (`package-lock.json`, `yarn.lock`) or validation scripts.
|
||||
3. Update or add test files for CI/CD logic.
|
||||
|
||||
---
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
- **Test Files:**
|
||||
Test files follow the pattern `*.test.js`.
|
||||
|
||||
- **Framework:**
|
||||
No specific testing framework detected; structure your tests in standard Node.js or your preferred test runner.
|
||||
|
||||
*Example:*
|
||||
```
|
||||
tests/lib/install-targets.test.js
|
||||
```
|
||||
|
||||
- **Test Example:**
|
||||
```js
|
||||
// install-targets.test.js
|
||||
const installTarget = require('../../scripts/lib/install-targets/gemini');
|
||||
|
||||
test('should install Gemini target', () => {
|
||||
expect(installTarget()).toBe(true);
|
||||
});
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Purpose |
|
||||
|--------------------|----------------------------------------------------------------|
|
||||
| /add-skill | Add a new skill module and document it |
|
||||
| /add-agent | Add a new agent definition or prompt |
|
||||
| /add-command | Add or update a command workflow |
|
||||
| /add-install-target| Add a new install target or adapter |
|
||||
| /refactor-to-skill | Refactor commands into skill-based modules |
|
||||
| /update-docs | Update documentation or guidance files |
|
||||
| /update-ci | Update CI/CD workflows, lockfiles, or validation scripts |
|
||||
```
|
||||
|
||||
@@ -10,7 +10,7 @@ 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.
|
||||
Adds a new skill to the codebase, typically as a new agent capability or workflow module.
|
||||
|
||||
## Common Files
|
||||
|
||||
@@ -28,8 +28,8 @@ Adds a new skill to the repository, enabling new agent capabilities or workflows
|
||||
## 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)
|
||||
- Document the skill's purpose, usage, and configuration.
|
||||
- Optionally update manifests or documentation if the skill is significant.
|
||||
|
||||
## Notes
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
"version": "1.3",
|
||||
"schemaVersion": "1.0",
|
||||
"generatedBy": "ecc-tools",
|
||||
"generatedAt": "2026-04-01T22:44:14.561Z",
|
||||
"generatedAt": "2026-04-01T22:51:43.152Z",
|
||||
"repo": "https://github.com/affaan-m/everything-claude-code",
|
||||
"profiles": {
|
||||
"requested": "full",
|
||||
|
||||
@@ -10,5 +10,5 @@
|
||||
"javascript"
|
||||
],
|
||||
"suggestedBy": "ecc-tools-repo-analysis",
|
||||
"createdAt": "2026-04-01T22:51:05.478Z"
|
||||
"createdAt": "2026-04-01T22:52:48.730Z"
|
||||
}
|
||||
@@ -26,7 +26,7 @@ Generated by ECC Tools from repository history. Review before treating it as a h
|
||||
|
||||
- feature-development: Standard feature implementation workflow
|
||||
- refactoring: Code refactoring and cleanup workflow
|
||||
- add-new-skill: Adds a new skill to the repository, enabling new agent capabilities or workflows.
|
||||
- add-new-skill: Adds a new skill to the codebase, typically as a new agent capability or workflow module.
|
||||
|
||||
## Review Reminder
|
||||
|
||||
|
||||
@@ -1,403 +1,175 @@
|
||||
---
|
||||
name: everything-claude-code-conventions
|
||||
description: Development conventions and patterns for everything-claude-code. JavaScript project with conventional commits.
|
||||
---
|
||||
```markdown
|
||||
# everything-claude-code Development Patterns
|
||||
|
||||
# Everything Claude Code Conventions
|
||||
|
||||
> Generated from [affaan-m/everything-claude-code](https://github.com/affaan-m/everything-claude-code) on 2026-04-01
|
||||
> Auto-generated skill from repository analysis
|
||||
|
||||
## Overview
|
||||
|
||||
This skill teaches Claude the development patterns and conventions used in everything-claude-code.
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- **Primary Language**: JavaScript
|
||||
- **Architecture**: hybrid module organization
|
||||
- **Test Location**: separate
|
||||
|
||||
## When to Use This 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
|
||||
|
||||
## Commit Conventions
|
||||
|
||||
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
|
||||
```
|
||||
This skill teaches the core development patterns, coding conventions, and common workflows used in the `everything-claude-code` repository. The codebase is primarily JavaScript, with no major framework, and is organized around modular skills, agent definitions, command workflows, and extensible install targets. The repository emphasizes clear documentation, conventional commits, and maintainable architecture for agent and workflow development.
|
||||
|
||||
## Coding Conventions
|
||||
|
||||
- **File Naming:**
|
||||
Use `camelCase` for JavaScript files and directories.
|
||||
*Example:*
|
||||
```
|
||||
scripts/lib/installTargets.js
|
||||
agentPrompts.md
|
||||
```
|
||||
|
||||
- **Import Style:**
|
||||
Use **relative imports** for modules.
|
||||
*Example:*
|
||||
```js
|
||||
const installTarget = require('../lib/installTargets');
|
||||
```
|
||||
|
||||
- **Export Style:**
|
||||
Both CommonJS (`module.exports`) and ES module (`export`) styles are present.
|
||||
*Example (CommonJS):*
|
||||
```js
|
||||
module.exports = function mySkill() { ... };
|
||||
```
|
||||
*Example (ES Module):*
|
||||
```js
|
||||
export function mySkill() { ... }
|
||||
```
|
||||
|
||||
- **Commit Messages:**
|
||||
Use [Conventional Commits](https://www.conventionalcommits.org/).
|
||||
Prefixes: `fix`, `feat`, `docs`, `chore`
|
||||
*Example:*
|
||||
```
|
||||
feat: add Gemini install target support
|
||||
fix: correct agent prompt registration logic
|
||||
```
|
||||
|
||||
- **Documentation:**
|
||||
Each skill or agent should have a `SKILL.md` or `.md` documentation file explaining its purpose and usage.
|
||||
|
||||
## Workflows
|
||||
|
||||
### Add New Skill
|
||||
**Trigger:** When introducing a new skill for agents or workflows
|
||||
**Command:** `/add-skill`
|
||||
|
||||
Adds a new skill to the repository, enabling new agent capabilities or workflows.
|
||||
1. Create a new `SKILL.md` file under `skills/`, `.agents/skills/`, or `.claude/skills/`.
|
||||
2. Document the skill's purpose, usage, and configuration.
|
||||
3. Optionally update manifests or documentation if the skill is significant.
|
||||
|
||||
**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**:
|
||||
*Example:*
|
||||
```
|
||||
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)
|
||||
skills/myNewSkill/SKILL.md
|
||||
```
|
||||
|
||||
### 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
|
||||
|
||||
---
|
||||
|
||||
*This skill was auto-generated by [ECC Tools](https://ecc.tools). Review and customize as needed for your team.*
|
||||
### Add New Agent or Agent Prompt
|
||||
**Trigger:** When introducing a new agent persona or capability
|
||||
**Command:** `/add-agent`
|
||||
|
||||
1. Create a new agent definition (e.g., `agents/myAgent.md` or `.opencode/prompts/agents/myAgent.txt`).
|
||||
2. Register the agent in the relevant configuration file (e.g., `.opencode/opencode.json`).
|
||||
3. Update `AGENTS.md` or related documentation.
|
||||
|
||||
*Example:*
|
||||
```
|
||||
agents/supportAgent.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update Command Workflow
|
||||
**Trigger:** When introducing or improving a workflow command
|
||||
**Command:** `/add-command`
|
||||
|
||||
1. Create or update a command file under `commands/` (e.g., `commands/review.md`).
|
||||
2. Optionally update related documentation or scripts.
|
||||
3. Address review feedback and refine command logic.
|
||||
|
||||
---
|
||||
|
||||
### Add Install Target or Adapter
|
||||
**Trigger:** When supporting a new platform or integration
|
||||
**Command:** `/add-install-target`
|
||||
|
||||
1. Add new install scripts and documentation under a dot-directory (e.g., `.gemini/`, `.codebuddy/`).
|
||||
2. Update `manifests/install-modules.json` and relevant schema files.
|
||||
3. Implement or update `scripts/lib/install-targets/*.js` for the new target.
|
||||
4. Add or update tests for the install target.
|
||||
|
||||
*Example:*
|
||||
```
|
||||
.gemini/install.sh
|
||||
scripts/lib/install-targets/gemini.js
|
||||
tests/lib/install-targets.test.js
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Refactor or Collapse Commands to Skills
|
||||
**Trigger:** When modernizing command logic under the skills architecture
|
||||
**Command:** `/refactor-to-skill`
|
||||
|
||||
1. Update or remove `commands/*.md` files.
|
||||
2. Add or update `skills/*/SKILL.md` files.
|
||||
3. Update documentation (`README.md`, `AGENTS.md`, `WORKING-CONTEXT.md`, etc.).
|
||||
4. Update manifests if required.
|
||||
|
||||
---
|
||||
|
||||
### Documentation and Guidance Update
|
||||
**Trigger:** When clarifying, updating, or adding documentation
|
||||
**Command:** `/update-docs`
|
||||
|
||||
1. Edit or create documentation files (`README.md`, `WORKING-CONTEXT.md`, `docs/*.md`, etc.).
|
||||
2. Sync or update guidance in multiple language versions if needed.
|
||||
3. Optionally update related configuration or manifest files.
|
||||
|
||||
---
|
||||
|
||||
### CI/CD Workflow Update
|
||||
**Trigger:** When improving or fixing CI/CD processes
|
||||
**Command:** `/update-ci`
|
||||
|
||||
1. Edit `.github/workflows/*.yml` files.
|
||||
2. Update lockfiles (`package-lock.json`, `yarn.lock`) or validation scripts.
|
||||
3. Update or add test files for CI/CD logic.
|
||||
|
||||
---
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
- **Test Files:**
|
||||
Test files follow the pattern `*.test.js`.
|
||||
|
||||
- **Framework:**
|
||||
No specific testing framework detected; structure your tests in standard Node.js or your preferred test runner.
|
||||
|
||||
*Example:*
|
||||
```
|
||||
tests/lib/install-targets.test.js
|
||||
```
|
||||
|
||||
- **Test Example:**
|
||||
```js
|
||||
// install-targets.test.js
|
||||
const installTarget = require('../../scripts/lib/install-targets/gemini');
|
||||
|
||||
test('should install Gemini target', () => {
|
||||
expect(installTarget()).toBe(true);
|
||||
});
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Purpose |
|
||||
|--------------------|----------------------------------------------------------------|
|
||||
| /add-skill | Add a new skill module and document it |
|
||||
| /add-agent | Add a new agent definition or prompt |
|
||||
| /add-command | Add or update a command workflow |
|
||||
| /add-install-target| Add a new install target or adapter |
|
||||
| /refactor-to-skill | Refactor commands into skill-based modules |
|
||||
| /update-docs | Update documentation or guidance files |
|
||||
| /update-ci | Update CI/CD workflows, lockfiles, or validation scripts |
|
||||
```
|
||||
|
||||
@@ -11,5 +11,5 @@
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-new-skill.md"
|
||||
],
|
||||
"updatedAt": "2026-04-01T22:44:14.561Z"
|
||||
"updatedAt": "2026-04-01T22:51:43.152Z"
|
||||
}
|
||||
Reference in New Issue
Block a user