mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-04-01 14:43:28 +08:00
Compare commits
15 Commits
ecc-tools/
...
ecc-tools/
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
732751dabf | ||
|
|
a81cffbd59 | ||
|
|
736f1e5b0b | ||
|
|
b71334ea36 | ||
|
|
02442ee94c | ||
|
|
b474d639fc | ||
|
|
823c99d5f2 | ||
|
|
2e0709732d | ||
|
|
32fbbd68a4 | ||
|
|
ef92a3742a | ||
|
|
4749ddc854 | ||
|
|
af761f1fd8 | ||
|
|
86a85b2904 | ||
|
|
f0c418e793 | ||
|
|
f488f59b2a |
@@ -1,349 +1,176 @@
|
||||
---
|
||||
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.
|
||||
This skill teaches the core development patterns, coding conventions, and collaborative workflows used in the `everything-claude-code` repository. The codebase is written in JavaScript (no framework detected) and is organized for modularity, clarity, and extensibility. It emphasizes clear commit messages, structured documentation, and repeatable workflows for adding new skills, commands, integrations, and conventions.
|
||||
|
||||
## Tech Stack
|
||||
## Coding Conventions
|
||||
|
||||
- **Primary Language**: JavaScript
|
||||
- **Architecture**: hybrid module organization
|
||||
- **Test Location**: separate
|
||||
- **File Naming:**
|
||||
Use `camelCase` for JavaScript files and directories.
|
||||
_Example:_
|
||||
```
|
||||
scripts/lib/installTargets.js
|
||||
tests/hooks/formatCheck.test.js
|
||||
```
|
||||
|
||||
## When to Use This Skill
|
||||
- **Import Style:**
|
||||
Use **relative imports** for modules within the codebase.
|
||||
_Example:_
|
||||
```js
|
||||
const installTarget = require('../../lib/installTargets');
|
||||
```
|
||||
|
||||
Activate this skill when:
|
||||
- Making changes to this repository
|
||||
- Adding new features following established patterns
|
||||
- Writing tests that match project conventions
|
||||
- Creating commits with proper message format
|
||||
- **Export Style:**
|
||||
Both CommonJS (`module.exports`) and ES module (`export`) styles are present.
|
||||
_Example (CommonJS):_
|
||||
```js
|
||||
module.exports = function runHook() { ... };
|
||||
```
|
||||
_Example (ES Module):_
|
||||
```js
|
||||
export function addSkill() { ... }
|
||||
```
|
||||
|
||||
## Commit Conventions
|
||||
- **Commit Messages:**
|
||||
Follow the **Conventional Commits** standard.
|
||||
- Prefixes: `fix`, `feat`, `docs`, `chore`
|
||||
- _Example:_
|
||||
```
|
||||
feat: add install target for VSCode integration
|
||||
fix: correct agent configuration parsing bug
|
||||
```
|
||||
|
||||
Follow these commit message conventions based on 500 analyzed commits.
|
||||
- **Documentation:**
|
||||
Markdown files are used extensively for documenting skills, commands, agents, and conventions.
|
||||
|
||||
### Commit Style: Conventional Commits
|
||||
## Workflows
|
||||
|
||||
### Prefixes Used
|
||||
### Add New Skill or Agent
|
||||
**Trigger:** When introducing a new skill or agent
|
||||
**Command:** `/add-skill`
|
||||
|
||||
- `fix`
|
||||
- `feat`
|
||||
- `docs`
|
||||
- `chore`
|
||||
1. Create a new `SKILL.md` file under `skills/<skill-name>/` or `.agents/skills/<agent-name>/`.
|
||||
2. Optionally, add supporting agent definition files (e.g., `agents/<agent-name>.md` or `.codex/agents/<agent-name>.toml`).
|
||||
3. Update or create related documentation/configuration files (e.g., `AGENTS.md`, `.opencode/opencode.json`).
|
||||
|
||||
### 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-or-update-command.md)
|
||||
_Example:_
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix: update ecc2 ratatui dependency
|
||||
skills/myNewSkill/SKILL.md
|
||||
.agents/skills/myAgent/SKILL.md
|
||||
agents/myAgent.md
|
||||
.codex/agents/myAgent.toml
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
docs: tighten pr backlog classification
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
refactor: fold social graph ranking into lead intelligence
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
chore: ignore local orchestration artifacts
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code ECC bundle (.claude/commands/add-new-agent-or-skill.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**: ~20 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(team-builder): use `claude agents` command for agent discovery (#1021)
|
||||
fix: extract inline SessionStart bootstrap to separate file (#1035)
|
||||
feat: add hexagonal architecture SKILL. (#1034)
|
||||
```
|
||||
|
||||
### Add New Skill Or Agent
|
||||
|
||||
Adds a new agent or skill to the codebase, including documentation and configuration.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create a new SKILL.md or agent markdown file in the appropriate directory (skills/ or agents/).
|
||||
2. Optionally add supporting files such as YAML configs or example usage.
|
||||
3. Update relevant index or manifest files if needed.
|
||||
|
||||
**Files typically involved**:
|
||||
- `skills/*/SKILL.md`
|
||||
- `agents/*.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `.claude/skills/*/SKILL.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create a new SKILL.md or agent markdown file in the appropriate directory (skills/ or agents/).
|
||||
Optionally add supporting files such as YAML configs or example usage.
|
||||
Update relevant index or manifest files if needed.
|
||||
```
|
||||
|
||||
### Add Or Update Command
|
||||
|
||||
Adds or updates a command markdown file, defining new CLI commands or workflows.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or update a markdown file in the commands/ or .claude/commands/ directory.
|
||||
2. Document the command's usage, arguments, and output.
|
||||
3. Optionally update related documentation or index files.
|
||||
|
||||
**Files typically involved**:
|
||||
- `commands/*.md`
|
||||
- `.claude/commands/*.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or update a markdown file in the commands/ or .claude/commands/ directory.
|
||||
Document the command's usage, arguments, and output.
|
||||
Optionally update related documentation or index files.
|
||||
```
|
||||
|
||||
### Add Or Update Install Target
|
||||
|
||||
Adds or updates an install target, including scripts, schemas, and manifest entries for new integrations.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add new install scripts (e.g., install.sh, install.js) in a dedicated directory.
|
||||
2. Update manifests/install-modules.json and relevant schema files.
|
||||
3. Update or add code in scripts/lib/install-manifests.js and install-targets/*.
|
||||
4. Add or update tests for install targets.
|
||||
|
||||
**Files typically involved**:
|
||||
- `manifests/install-modules.json`
|
||||
- `schemas/ecc-install-config.schema.json`
|
||||
- `schemas/install-modules.schema.json`
|
||||
- `scripts/lib/install-manifests.js`
|
||||
- `scripts/lib/install-targets/*.js`
|
||||
- `tests/lib/install-targets.test.js`
|
||||
- `.*/install.*`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Add new install scripts (e.g., install.sh, install.js) in a dedicated directory.
|
||||
Update manifests/install-modules.json and relevant schema files.
|
||||
Update or add code in scripts/lib/install-manifests.js and install-targets/*.
|
||||
Add or update tests for install targets.
|
||||
```
|
||||
|
||||
### Update Hooks Or Hook Scripts
|
||||
|
||||
Updates hook configuration or scripts to change automation, formatting, or session management behaviors.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit hooks/hooks.json to add or modify hook definitions.
|
||||
2. Update or add scripts in scripts/hooks/ or tests/hooks/.
|
||||
3. Optionally update related shell scripts or adapters.
|
||||
|
||||
**Files typically involved**:
|
||||
- `hooks/hooks.json`
|
||||
- `scripts/hooks/*.js`
|
||||
- `scripts/hooks/*.sh`
|
||||
- `tests/hooks/*.test.js`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit hooks/hooks.json to add or modify hook definitions.
|
||||
Update or add scripts in scripts/hooks/ or tests/hooks/.
|
||||
Optionally update related shell scripts or adapters.
|
||||
```
|
||||
|
||||
### Dependency Bump Github Actions
|
||||
|
||||
Automated or manual updates to GitHub Actions dependencies for CI/CD workflows.
|
||||
|
||||
**Frequency**: ~4 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Update version numbers in .github/workflows/*.yml files for specific actions.
|
||||
2. Commit with a standardized message indicating the dependency and new version.
|
||||
|
||||
**Files typically involved**:
|
||||
- `.github/workflows/*.yml`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Update version numbers in .github/workflows/*.yml files for specific actions.
|
||||
Commit with a standardized message indicating the dependency and new version.
|
||||
```
|
||||
|
||||
|
||||
## 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 Command
|
||||
**Trigger:** When introducing a new CLI command or workflow
|
||||
**Command:** `/add-command`
|
||||
|
||||
1. Create or update a markdown file in `commands/` (e.g., `commands/myCommand.md`).
|
||||
2. Document usage, purpose, and output in YAML frontmatter and markdown sections.
|
||||
3. Optionally update related documentation or test files.
|
||||
|
||||
_Example:_
|
||||
```
|
||||
commands/reviewFlow.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update Install Target
|
||||
**Trigger:** When supporting a new IDE, platform, or agent integration
|
||||
**Command:** `/add-install-target`
|
||||
|
||||
1. Add new install scripts and documentation under a tool-specific directory (e.g., `.codebuddy/`, `.gemini/`).
|
||||
2. Update `manifests/install-modules.json` and related schema files.
|
||||
3. Update or add scripts in `scripts/lib/install-targets/<target>.js`.
|
||||
4. Update or add tests for install targets.
|
||||
|
||||
_Example:_
|
||||
```
|
||||
.codebuddy/install.sh
|
||||
manifests/install-modules.json
|
||||
scripts/lib/install-targets/codebuddy.js
|
||||
tests/lib/install-targets.test.js
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Dependency Bump for GitHub Actions
|
||||
**Trigger:** When a new version of a GitHub Actions dependency is released
|
||||
**Command:** `/bump-action`
|
||||
|
||||
1. Update version numbers in `.github/workflows/*.yml` for specific actions.
|
||||
2. Commit with a standardized message indicating the dependency and new version.
|
||||
|
||||
_Example:_
|
||||
```
|
||||
.github/workflows/ci.yml
|
||||
# Update:
|
||||
- uses: actions/checkout@v4
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Fix or Update Hook Scripts
|
||||
**Trigger:** When improving or repairing CLI/editor hooks
|
||||
**Command:** `/fix-hook`
|
||||
|
||||
1. Modify `hooks/hooks.json` to adjust hook configuration or add/remove hooks.
|
||||
2. Update or add scripts in `scripts/hooks/*.js` or `scripts/hooks/*.sh` for hook logic.
|
||||
3. Update or add tests in `tests/hooks/*.test.js`.
|
||||
|
||||
_Example:_
|
||||
```
|
||||
hooks/hooks.json
|
||||
scripts/hooks/formatCheck.js
|
||||
tests/hooks/formatCheck.test.js
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update ECC Conventions Bundle
|
||||
**Trigger:** When formalizing or updating project conventions and team/process documentation
|
||||
**Command:** `/add-convention`
|
||||
|
||||
1. Add or update markdown or JSON files under `.claude/commands/`, `.claude/rules/`, `.claude/team/`, `.claude/research/`, or `.claude/skills/`.
|
||||
2. Document new or updated conventions, rules, or playbooks.
|
||||
|
||||
_Example:_
|
||||
```
|
||||
.claude/commands/codeReview.md
|
||||
.claude/rules/commitMessage.md
|
||||
.claude/team/members.json
|
||||
.claude/skills/automation/SKILL.md
|
||||
```
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
- **Test Files:**
|
||||
Test files follow the pattern `*.test.js` and are colocated with the code they test or in dedicated `tests/` directories.
|
||||
|
||||
- **Framework:**
|
||||
No specific testing framework detected; use standard Node.js assertions or your preferred test runner.
|
||||
|
||||
_Example:_
|
||||
```
|
||||
tests/lib/install-targets.test.js
|
||||
tests/hooks/formatCheck.test.js
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Purpose |
|
||||
|-------------------|----------------------------------------------------------------|
|
||||
| /add-skill | Add a new skill or agent, including documentation and config |
|
||||
| /add-command | Add or update a CLI command or workflow |
|
||||
| /add-install-target | Add or update an install target for integrations |
|
||||
| /bump-action | Bump GitHub Actions workflow dependencies |
|
||||
| /fix-hook | Fix, refactor, or enhance hook scripts and configuration |
|
||||
| /add-convention | Add or update ECC conventions, rules, or team configs |
|
||||
```
|
||||
|
||||
@@ -10,14 +10,16 @@ Use this workflow when working on **add-new-skill-or-agent** in `everything-clau
|
||||
|
||||
## Goal
|
||||
|
||||
Adds a new agent or skill to the codebase, including documentation and configuration.
|
||||
Adds a new skill or agent to the codebase, including documentation and configuration.
|
||||
|
||||
## Common Files
|
||||
|
||||
- `skills/*/SKILL.md`
|
||||
- `agents/*.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `.claude/skills/*/SKILL.md`
|
||||
- `agents/*.md`
|
||||
- `.codex/agents/*.toml`
|
||||
- `AGENTS.md`
|
||||
- `.opencode/opencode.json`
|
||||
|
||||
## Suggested Sequence
|
||||
|
||||
@@ -28,9 +30,9 @@ Adds a new agent or skill to the codebase, including documentation and configura
|
||||
|
||||
## Typical Commit Signals
|
||||
|
||||
- Create a new SKILL.md or agent markdown file in the appropriate directory (skills/ or agents/).
|
||||
- Optionally add supporting files such as YAML configs or example usage.
|
||||
- Update relevant index or manifest files if needed.
|
||||
- Create a new SKILL.md file under skills/<skill-name>/ or .agents/skills/<agent-name>/
|
||||
- Optionally add supporting agent definition files (e.g., agents/<agent-name>.md or .codex/agents/<agent-name>.toml)
|
||||
- Update or create related documentation or configuration files (e.g., AGENTS.md, opencode.json)
|
||||
|
||||
## Notes
|
||||
|
||||
|
||||
@@ -10,12 +10,11 @@ Use this workflow when working on **add-or-update-command** in `everything-claud
|
||||
|
||||
## Goal
|
||||
|
||||
Adds or updates a command markdown file, defining new CLI commands or workflows.
|
||||
Adds or updates a command file, often for new workflows, review flows, or agent orchestration.
|
||||
|
||||
## Common Files
|
||||
|
||||
- `commands/*.md`
|
||||
- `.claude/commands/*.md`
|
||||
|
||||
## Suggested Sequence
|
||||
|
||||
@@ -26,9 +25,9 @@ Adds or updates a command markdown file, defining new CLI commands or workflows.
|
||||
|
||||
## Typical Commit Signals
|
||||
|
||||
- Create or update a markdown file in the commands/ or .claude/commands/ directory.
|
||||
- Document the command's usage, arguments, and output.
|
||||
- Optionally update related documentation or index files.
|
||||
- Create or update a markdown file in commands/ (e.g., commands/<command>.md)
|
||||
- Document usage, purpose, and output in YAML frontmatter and markdown sections
|
||||
- Optionally update related documentation or test files
|
||||
|
||||
## Notes
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
"version": "1.3",
|
||||
"schemaVersion": "1.0",
|
||||
"generatedBy": "ecc-tools",
|
||||
"generatedAt": "2026-04-01T01:39:13.874Z",
|
||||
"generatedAt": "2026-04-01T04:44:14.185Z",
|
||||
"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-01T04:43:36.259Z"
|
||||
"createdAt": "2026-04-01T04:44:50.680Z"
|
||||
}
|
||||
@@ -18,4 +18,4 @@ Use this when the task is documentation-heavy, source-sensitive, or requires bro
|
||||
|
||||
- Primary language: JavaScript
|
||||
- Framework: Not detected
|
||||
- Workflows detected: 6
|
||||
- Workflows detected: 7
|
||||
@@ -25,8 +25,8 @@ Generated by ECC Tools from repository history. Review before treating it as a h
|
||||
## Detected Workflows
|
||||
|
||||
- feature-development: Standard feature implementation workflow
|
||||
- add-new-skill-or-agent: Adds a new agent or skill to the codebase, including documentation and configuration.
|
||||
- add-or-update-command: Adds or updates a command markdown file, defining new CLI commands or workflows.
|
||||
- add-new-skill-or-agent: Adds a new skill or agent to the codebase, including documentation and configuration.
|
||||
- add-or-update-command: Adds or updates a command file, often for new workflows, review flows, or agent orchestration.
|
||||
|
||||
## Review Reminder
|
||||
|
||||
|
||||
@@ -1,349 +1,176 @@
|
||||
---
|
||||
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.
|
||||
This skill teaches the core development patterns, coding conventions, and collaborative workflows used in the `everything-claude-code` repository. The codebase is written in JavaScript (no framework detected) and is organized for modularity, clarity, and extensibility. It emphasizes clear commit messages, structured documentation, and repeatable workflows for adding new skills, commands, integrations, and conventions.
|
||||
|
||||
## Tech Stack
|
||||
## Coding Conventions
|
||||
|
||||
- **Primary Language**: JavaScript
|
||||
- **Architecture**: hybrid module organization
|
||||
- **Test Location**: separate
|
||||
- **File Naming:**
|
||||
Use `camelCase` for JavaScript files and directories.
|
||||
_Example:_
|
||||
```
|
||||
scripts/lib/installTargets.js
|
||||
tests/hooks/formatCheck.test.js
|
||||
```
|
||||
|
||||
## When to Use This Skill
|
||||
- **Import Style:**
|
||||
Use **relative imports** for modules within the codebase.
|
||||
_Example:_
|
||||
```js
|
||||
const installTarget = require('../../lib/installTargets');
|
||||
```
|
||||
|
||||
Activate this skill when:
|
||||
- Making changes to this repository
|
||||
- Adding new features following established patterns
|
||||
- Writing tests that match project conventions
|
||||
- Creating commits with proper message format
|
||||
- **Export Style:**
|
||||
Both CommonJS (`module.exports`) and ES module (`export`) styles are present.
|
||||
_Example (CommonJS):_
|
||||
```js
|
||||
module.exports = function runHook() { ... };
|
||||
```
|
||||
_Example (ES Module):_
|
||||
```js
|
||||
export function addSkill() { ... }
|
||||
```
|
||||
|
||||
## Commit Conventions
|
||||
- **Commit Messages:**
|
||||
Follow the **Conventional Commits** standard.
|
||||
- Prefixes: `fix`, `feat`, `docs`, `chore`
|
||||
- _Example:_
|
||||
```
|
||||
feat: add install target for VSCode integration
|
||||
fix: correct agent configuration parsing bug
|
||||
```
|
||||
|
||||
Follow these commit message conventions based on 500 analyzed commits.
|
||||
- **Documentation:**
|
||||
Markdown files are used extensively for documenting skills, commands, agents, and conventions.
|
||||
|
||||
### Commit Style: Conventional Commits
|
||||
## Workflows
|
||||
|
||||
### Prefixes Used
|
||||
### Add New Skill or Agent
|
||||
**Trigger:** When introducing a new skill or agent
|
||||
**Command:** `/add-skill`
|
||||
|
||||
- `fix`
|
||||
- `feat`
|
||||
- `docs`
|
||||
- `chore`
|
||||
1. Create a new `SKILL.md` file under `skills/<skill-name>/` or `.agents/skills/<agent-name>/`.
|
||||
2. Optionally, add supporting agent definition files (e.g., `agents/<agent-name>.md` or `.codex/agents/<agent-name>.toml`).
|
||||
3. Update or create related documentation/configuration files (e.g., `AGENTS.md`, `.opencode/opencode.json`).
|
||||
|
||||
### 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-or-update-command.md)
|
||||
_Example:_
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix: update ecc2 ratatui dependency
|
||||
skills/myNewSkill/SKILL.md
|
||||
.agents/skills/myAgent/SKILL.md
|
||||
agents/myAgent.md
|
||||
.codex/agents/myAgent.toml
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
docs: tighten pr backlog classification
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
refactor: fold social graph ranking into lead intelligence
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
chore: ignore local orchestration artifacts
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code ECC bundle (.claude/commands/add-new-agent-or-skill.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**: ~20 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(team-builder): use `claude agents` command for agent discovery (#1021)
|
||||
fix: extract inline SessionStart bootstrap to separate file (#1035)
|
||||
feat: add hexagonal architecture SKILL. (#1034)
|
||||
```
|
||||
|
||||
### Add New Skill Or Agent
|
||||
|
||||
Adds a new agent or skill to the codebase, including documentation and configuration.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create a new SKILL.md or agent markdown file in the appropriate directory (skills/ or agents/).
|
||||
2. Optionally add supporting files such as YAML configs or example usage.
|
||||
3. Update relevant index or manifest files if needed.
|
||||
|
||||
**Files typically involved**:
|
||||
- `skills/*/SKILL.md`
|
||||
- `agents/*.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `.claude/skills/*/SKILL.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create a new SKILL.md or agent markdown file in the appropriate directory (skills/ or agents/).
|
||||
Optionally add supporting files such as YAML configs or example usage.
|
||||
Update relevant index or manifest files if needed.
|
||||
```
|
||||
|
||||
### Add Or Update Command
|
||||
|
||||
Adds or updates a command markdown file, defining new CLI commands or workflows.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or update a markdown file in the commands/ or .claude/commands/ directory.
|
||||
2. Document the command's usage, arguments, and output.
|
||||
3. Optionally update related documentation or index files.
|
||||
|
||||
**Files typically involved**:
|
||||
- `commands/*.md`
|
||||
- `.claude/commands/*.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or update a markdown file in the commands/ or .claude/commands/ directory.
|
||||
Document the command's usage, arguments, and output.
|
||||
Optionally update related documentation or index files.
|
||||
```
|
||||
|
||||
### Add Or Update Install Target
|
||||
|
||||
Adds or updates an install target, including scripts, schemas, and manifest entries for new integrations.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add new install scripts (e.g., install.sh, install.js) in a dedicated directory.
|
||||
2. Update manifests/install-modules.json and relevant schema files.
|
||||
3. Update or add code in scripts/lib/install-manifests.js and install-targets/*.
|
||||
4. Add or update tests for install targets.
|
||||
|
||||
**Files typically involved**:
|
||||
- `manifests/install-modules.json`
|
||||
- `schemas/ecc-install-config.schema.json`
|
||||
- `schemas/install-modules.schema.json`
|
||||
- `scripts/lib/install-manifests.js`
|
||||
- `scripts/lib/install-targets/*.js`
|
||||
- `tests/lib/install-targets.test.js`
|
||||
- `.*/install.*`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Add new install scripts (e.g., install.sh, install.js) in a dedicated directory.
|
||||
Update manifests/install-modules.json and relevant schema files.
|
||||
Update or add code in scripts/lib/install-manifests.js and install-targets/*.
|
||||
Add or update tests for install targets.
|
||||
```
|
||||
|
||||
### Update Hooks Or Hook Scripts
|
||||
|
||||
Updates hook configuration or scripts to change automation, formatting, or session management behaviors.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit hooks/hooks.json to add or modify hook definitions.
|
||||
2. Update or add scripts in scripts/hooks/ or tests/hooks/.
|
||||
3. Optionally update related shell scripts or adapters.
|
||||
|
||||
**Files typically involved**:
|
||||
- `hooks/hooks.json`
|
||||
- `scripts/hooks/*.js`
|
||||
- `scripts/hooks/*.sh`
|
||||
- `tests/hooks/*.test.js`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit hooks/hooks.json to add or modify hook definitions.
|
||||
Update or add scripts in scripts/hooks/ or tests/hooks/.
|
||||
Optionally update related shell scripts or adapters.
|
||||
```
|
||||
|
||||
### Dependency Bump Github Actions
|
||||
|
||||
Automated or manual updates to GitHub Actions dependencies for CI/CD workflows.
|
||||
|
||||
**Frequency**: ~4 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Update version numbers in .github/workflows/*.yml files for specific actions.
|
||||
2. Commit with a standardized message indicating the dependency and new version.
|
||||
|
||||
**Files typically involved**:
|
||||
- `.github/workflows/*.yml`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Update version numbers in .github/workflows/*.yml files for specific actions.
|
||||
Commit with a standardized message indicating the dependency and new version.
|
||||
```
|
||||
|
||||
|
||||
## 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 Command
|
||||
**Trigger:** When introducing a new CLI command or workflow
|
||||
**Command:** `/add-command`
|
||||
|
||||
1. Create or update a markdown file in `commands/` (e.g., `commands/myCommand.md`).
|
||||
2. Document usage, purpose, and output in YAML frontmatter and markdown sections.
|
||||
3. Optionally update related documentation or test files.
|
||||
|
||||
_Example:_
|
||||
```
|
||||
commands/reviewFlow.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update Install Target
|
||||
**Trigger:** When supporting a new IDE, platform, or agent integration
|
||||
**Command:** `/add-install-target`
|
||||
|
||||
1. Add new install scripts and documentation under a tool-specific directory (e.g., `.codebuddy/`, `.gemini/`).
|
||||
2. Update `manifests/install-modules.json` and related schema files.
|
||||
3. Update or add scripts in `scripts/lib/install-targets/<target>.js`.
|
||||
4. Update or add tests for install targets.
|
||||
|
||||
_Example:_
|
||||
```
|
||||
.codebuddy/install.sh
|
||||
manifests/install-modules.json
|
||||
scripts/lib/install-targets/codebuddy.js
|
||||
tests/lib/install-targets.test.js
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Dependency Bump for GitHub Actions
|
||||
**Trigger:** When a new version of a GitHub Actions dependency is released
|
||||
**Command:** `/bump-action`
|
||||
|
||||
1. Update version numbers in `.github/workflows/*.yml` for specific actions.
|
||||
2. Commit with a standardized message indicating the dependency and new version.
|
||||
|
||||
_Example:_
|
||||
```
|
||||
.github/workflows/ci.yml
|
||||
# Update:
|
||||
- uses: actions/checkout@v4
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Fix or Update Hook Scripts
|
||||
**Trigger:** When improving or repairing CLI/editor hooks
|
||||
**Command:** `/fix-hook`
|
||||
|
||||
1. Modify `hooks/hooks.json` to adjust hook configuration or add/remove hooks.
|
||||
2. Update or add scripts in `scripts/hooks/*.js` or `scripts/hooks/*.sh` for hook logic.
|
||||
3. Update or add tests in `tests/hooks/*.test.js`.
|
||||
|
||||
_Example:_
|
||||
```
|
||||
hooks/hooks.json
|
||||
scripts/hooks/formatCheck.js
|
||||
tests/hooks/formatCheck.test.js
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update ECC Conventions Bundle
|
||||
**Trigger:** When formalizing or updating project conventions and team/process documentation
|
||||
**Command:** `/add-convention`
|
||||
|
||||
1. Add or update markdown or JSON files under `.claude/commands/`, `.claude/rules/`, `.claude/team/`, `.claude/research/`, or `.claude/skills/`.
|
||||
2. Document new or updated conventions, rules, or playbooks.
|
||||
|
||||
_Example:_
|
||||
```
|
||||
.claude/commands/codeReview.md
|
||||
.claude/rules/commitMessage.md
|
||||
.claude/team/members.json
|
||||
.claude/skills/automation/SKILL.md
|
||||
```
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
- **Test Files:**
|
||||
Test files follow the pattern `*.test.js` and are colocated with the code they test or in dedicated `tests/` directories.
|
||||
|
||||
- **Framework:**
|
||||
No specific testing framework detected; use standard Node.js assertions or your preferred test runner.
|
||||
|
||||
_Example:_
|
||||
```
|
||||
tests/lib/install-targets.test.js
|
||||
tests/hooks/formatCheck.test.js
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Purpose |
|
||||
|-------------------|----------------------------------------------------------------|
|
||||
| /add-skill | Add a new skill or agent, including documentation and config |
|
||||
| /add-command | Add or update a CLI command or workflow |
|
||||
| /add-install-target | Add or update an install target for integrations |
|
||||
| /bump-action | Bump GitHub Actions workflow dependencies |
|
||||
| /fix-hook | Fix, refactor, or enhance hook scripts and configuration |
|
||||
| /add-convention | Add or update ECC conventions, rules, or team configs |
|
||||
```
|
||||
|
||||
@@ -11,5 +11,5 @@
|
||||
".claude/commands/add-new-skill-or-agent.md",
|
||||
".claude/commands/add-or-update-command.md"
|
||||
],
|
||||
"updatedAt": "2026-04-01T01:39:13.874Z"
|
||||
"updatedAt": "2026-04-01T04:44:14.185Z"
|
||||
}
|
||||
Reference in New Issue
Block a user