mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-04-03 07:33:31 +08:00
Compare commits
15 Commits
ecc-tools/
...
ecc-tools/
| Author | SHA1 | Date | |
|---|---|---|---|
|
2f3ff051ca | ||
|
|
3a55f1ef50 | ||
|
|
956e6d51d2 | ||
|
|
374a1c448f | ||
|
|
db3ea82643 | ||
|
|
466031da42 | ||
|
|
1f9d4cca7c | ||
|
|
74602e9ff5 | ||
|
|
6a8eb7aeb1 | ||
|
|
1dae9edb58 | ||
|
|
81569ab994 | ||
|
|
8a8f159153 | ||
|
|
a083aa5811 | ||
|
|
6f7bfd72ad | ||
|
|
c104217cab |
@@ -1,412 +1,150 @@
|
||||
---
|
||||
name: everything-claude-code-conventions
|
||||
description: Development conventions and patterns for everything-claude-code. JavaScript project with conventional commits.
|
||||
---
|
||||
```markdown
|
||||
# everything-claude-code Development Patterns
|
||||
|
||||
# Everything Claude Code Conventions
|
||||
|
||||
> Generated from [affaan-m/everything-claude-code](https://github.com/affaan-m/everything-claude-code) on 2026-04-02
|
||||
> Auto-generated skill from repository analysis
|
||||
|
||||
## Overview
|
||||
|
||||
This skill teaches Claude the development patterns and conventions used in everything-claude-code.
|
||||
This skill provides a comprehensive guide to the development patterns, workflows, and coding conventions used in the `everything-claude-code` repository. It covers how to add or update skills, commands, install targets, hooks, and documentation, as well as the repository's JavaScript coding style and testing patterns. This guide is intended for contributors looking to maintain consistency and efficiency when working within this codebase.
|
||||
|
||||
## Tech Stack
|
||||
## Coding Conventions
|
||||
|
||||
- **Primary Language**: JavaScript
|
||||
- **Architecture**: hybrid module organization
|
||||
- **Test Location**: separate
|
||||
- **Language:** JavaScript (no framework detected)
|
||||
- **File Naming:** Use `camelCase` for JavaScript files and folders.
|
||||
- Example: `mySkill.js`, `installTarget.js`
|
||||
- **Import Style:** Use relative imports.
|
||||
- Example:
|
||||
```js
|
||||
import myUtil from './utils/myUtil.js';
|
||||
```
|
||||
- **Export Style:** Mixed (both default and named exports are used).
|
||||
- Example:
|
||||
```js
|
||||
// Named export
|
||||
export function doSomething() { ... }
|
||||
|
||||
## When to Use This Skill
|
||||
// Default export
|
||||
export default MyComponent;
|
||||
```
|
||||
- **Commit Messages:** Follow [Conventional Commits](https://www.conventionalcommits.org/) with prefixes like `fix`, `feat`, `docs`, `chore`.
|
||||
- Example: `feat: add support for new install target`
|
||||
- **Documentation:** Each skill or command should have a `SKILL.md` or markdown documentation file in its directory.
|
||||
|
||||
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
|
||||
## Workflows
|
||||
|
||||
## Commit Conventions
|
||||
### Add or Update a Skill
|
||||
**Trigger:** When adding or updating a skill for agents or workflows
|
||||
**Command:** `/add-skill`
|
||||
|
||||
Follow these commit message conventions based on 500 analyzed commits.
|
||||
1. Create or update `SKILL.md` in `skills/[skill-name]/` or `.agents/skills/[skill-name]/`.
|
||||
2. Optionally add or update related reference files (e.g., `references/*.md`, `assets/*.py`).
|
||||
3. Register the skill in `manifests/install-modules.json` and/or `manifests/install-components.json`.
|
||||
4. Update `AGENTS.md`, `README.md`, and `docs/zh-CN/AGENTS.md` as needed.
|
||||
5. If the skill is agent-facing, update `.agents/skills/[skill-name]/SKILL.md`.
|
||||
|
||||
### 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-or-update-skill.md)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
refactor: extract social graph ranking core
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix: port safe ci cleanup from backlog
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
docs: close bundle drift and sync plugin guidance
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
chore: ignore local orchestration artifacts
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: 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')
|
||||
**Example:**
|
||||
```json
|
||||
// manifests/install-modules.json
|
||||
{
|
||||
"skills": [
|
||||
"myNewSkill"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Common Workflows
|
||||
---
|
||||
|
||||
These workflows were detected from analyzing commit patterns.
|
||||
### Add or Update a Command Workflow
|
||||
**Trigger:** When introducing or refining a workflow command
|
||||
**Command:** `/add-command`
|
||||
|
||||
### Feature Development
|
||||
1. Create or update a command markdown file in `commands/` or `.claude/commands/`.
|
||||
2. Iterate based on review feedback (fixes, improvements, removal of external links, etc.).
|
||||
3. Update related documentation or references if needed.
|
||||
|
||||
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.*`
|
||||
- `**/api/**`
|
||||
|
||||
**Example commit sequence**:
|
||||
**Example:**
|
||||
```markdown
|
||||
// commands/myCommand.md
|
||||
# My Command
|
||||
Description and usage...
|
||||
```
|
||||
feat(install): add CodeBuddy(Tencent) adaptation with installation scripts (#1038)
|
||||
chore(deps-dev): bump c8 from 10.1.3 to 11.0.0 (#1065)
|
||||
chore(deps): bump actions/checkout from 4.3.1 to 6.0.2 (#1060)
|
||||
```
|
||||
|
||||
### Refactoring
|
||||
|
||||
Code refactoring and cleanup workflow
|
||||
|
||||
**Frequency**: ~4 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 Or Update Skill
|
||||
|
||||
Adds a new skill or updates an existing skill, including documentation and registration in manifests.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or modify SKILL.md in skills/<skill-name>/ or .agents/skills/<skill-name>/
|
||||
2. Update manifests/install-modules.json and/or manifests/install-components.json to register the skill
|
||||
3. Update AGENTS.md, README.md, and docs/zh-CN/AGENTS.md for documentation and agent tables
|
||||
4. Optionally add or update reference files or assets under the skill directory
|
||||
|
||||
**Files typically involved**:
|
||||
- `skills/*/SKILL.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `manifests/install-modules.json`
|
||||
- `manifests/install-components.json`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or modify SKILL.md in skills/<skill-name>/ or .agents/skills/<skill-name>/
|
||||
Update manifests/install-modules.json and/or manifests/install-components.json to register the skill
|
||||
Update AGENTS.md, README.md, and docs/zh-CN/AGENTS.md for documentation and agent tables
|
||||
Optionally add or update reference files or assets under the skill directory
|
||||
```
|
||||
|
||||
### Add Or Update Command
|
||||
|
||||
Adds or updates a workflow command for the Claude agentic system.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or modify a markdown file in commands/ or .claude/commands/
|
||||
2. Document the workflow, arguments, and usage
|
||||
3. Optionally update related documentation (README.md, AGENTS.md, etc.)
|
||||
|
||||
**Files typically involved**:
|
||||
- `commands/*.md`
|
||||
- `.claude/commands/*.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or modify a markdown file in commands/ or .claude/commands/
|
||||
Document the workflow, arguments, and usage
|
||||
Optionally update related documentation (README.md, AGENTS.md, etc.)
|
||||
```
|
||||
|
||||
### Refactor Skill Or Agent Logic
|
||||
|
||||
Refactors core logic or merges/splits skills, updating documentation and manifests accordingly.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit or move SKILL.md files in skills/ or .agents/skills/
|
||||
2. Update manifests/install-modules.json and/or manifests/install-components.json
|
||||
3. Update documentation files (AGENTS.md, README.md, docs/zh-CN/AGENTS.md, etc.)
|
||||
|
||||
**Files typically involved**:
|
||||
- `skills/*/SKILL.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `manifests/install-modules.json`
|
||||
- `manifests/install-components.json`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit or move SKILL.md files in skills/ or .agents/skills/
|
||||
Update manifests/install-modules.json and/or manifests/install-components.json
|
||||
Update documentation files (AGENTS.md, README.md, docs/zh-CN/AGENTS.md, etc.)
|
||||
```
|
||||
|
||||
### Add Or Update Install Target
|
||||
|
||||
Adds or updates an install target (e.g., Gemini, CodeBuddy) including scripts, schemas, and registration.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add new directory and scripts under .<target>/ (e.g., .gemini/, .codebuddy/)
|
||||
2. Update manifests/install-modules.json and schemas/ecc-install-config.schema.json
|
||||
3. Add or update scripts/lib/install-targets/<target>-project.js and registry.js
|
||||
4. Update or add tests for install targets
|
||||
|
||||
**Files typically involved**:
|
||||
- `.<target>/*`
|
||||
- `manifests/install-modules.json`
|
||||
- `schemas/ecc-install-config.schema.json`
|
||||
- `schemas/install-modules.schema.json`
|
||||
- `scripts/lib/install-manifests.js`
|
||||
- `scripts/lib/install-targets/<target>-project.js`
|
||||
- `scripts/lib/install-targets/registry.js`
|
||||
- `tests/lib/install-targets.test.js`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Add new directory and scripts under .<target>/ (e.g., .gemini/, .codebuddy/)
|
||||
Update manifests/install-modules.json and schemas/ecc-install-config.schema.json
|
||||
Add or update scripts/lib/install-targets/<target>-project.js and registry.js
|
||||
Update or add tests for install targets
|
||||
```
|
||||
|
||||
### Documentation Sync And Update
|
||||
|
||||
Synchronizes and updates documentation across multiple files and languages.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit AGENTS.md, README.md, README.zh-CN.md, WORKING-CONTEXT.md
|
||||
2. Edit docs/zh-CN/AGENTS.md, docs/zh-CN/README.md
|
||||
3. Optionally update .agents/skills/*/SKILL.md and related documentation
|
||||
|
||||
**Files typically involved**:
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `WORKING-CONTEXT.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
- `docs/zh-CN/README.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit AGENTS.md, README.md, README.zh-CN.md, WORKING-CONTEXT.md
|
||||
Edit docs/zh-CN/AGENTS.md, docs/zh-CN/README.md
|
||||
Optionally update .agents/skills/*/SKILL.md and related documentation
|
||||
```
|
||||
|
||||
### Update Or Add Hooks And Ci
|
||||
|
||||
Updates or adds new hooks, CI scripts, and related tests for code quality and automation.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit hooks/hooks.json and/or scripts/hooks/*.js
|
||||
2. Update or add tests in tests/hooks/*.test.js or tests/scripts/*.test.js
|
||||
3. Update CI workflow files in .github/workflows/
|
||||
|
||||
**Files typically involved**:
|
||||
- `hooks/hooks.json`
|
||||
- `scripts/hooks/*.js`
|
||||
- `tests/hooks/*.test.js`
|
||||
- `tests/scripts/*.test.js`
|
||||
- `.github/workflows/*.yml`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit hooks/hooks.json and/or scripts/hooks/*.js
|
||||
Update or add tests in tests/hooks/*.test.js or tests/scripts/*.test.js
|
||||
Update CI workflow files in .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.*
|
||||
### Refactor Skill or Agent Structure
|
||||
**Trigger:** When reorganizing skills, merging/splitting logic, or extracting shared code
|
||||
**Command:** `/refactor-skill`
|
||||
|
||||
1. Edit multiple `SKILL.md` files in `skills/` and/or `.agents/skills/`.
|
||||
2. Update `AGENTS.md`, `README.md`, `README.zh-CN.md`, and `docs/zh-CN/*` as needed.
|
||||
3. Update `manifests/install-modules.json` or related manifests.
|
||||
4. Remove or merge obsolete command files.
|
||||
|
||||
---
|
||||
|
||||
### Add or Update Install Target
|
||||
**Trigger:** When supporting a new platform or updating install logic
|
||||
**Command:** `/add-install-target`
|
||||
|
||||
1. Add or update install scripts and documentation under a dot-directory (e.g., `.codebuddy/`, `.gemini/`).
|
||||
2. Update `manifests/install-modules.json` and `schemas/ecc-install-config.schema.json`.
|
||||
3. Update or create scripts in `scripts/lib/install-targets/[target].js`.
|
||||
4. Update `registry.js` and `install-manifests.js` as needed.
|
||||
5. Add or update tests in `tests/lib/install-targets.test.js`.
|
||||
|
||||
**Example:**
|
||||
```js
|
||||
// scripts/lib/install-targets/codeBuddy.js
|
||||
export function installCodeBuddy() { ... }
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Update Hooks and Automation
|
||||
**Trigger:** When improving or fixing hooks, audit logs, or CI/CD automation
|
||||
**Command:** `/update-hook`
|
||||
|
||||
1. Edit `hooks/hooks.json` and/or add/update `scripts/hooks/*.js`.
|
||||
2. Update or add related test files in `tests/hooks/` or `tests/scripts/`.
|
||||
3. Edit `.github/workflows/*.yml` for CI/CD changes.
|
||||
4. Update `package.json` or related config if needed.
|
||||
|
||||
---
|
||||
|
||||
### Documentation Sync and Guidance Update
|
||||
**Trigger:** When updating repo guidance, syncing documentation, or clarifying workflows
|
||||
**Command:** `/update-docs`
|
||||
|
||||
1. Edit one or more of `AGENTS.md`, `README.md`, `README.zh-CN.md`, `WORKING-CONTEXT.md`, and `docs/zh-CN/*`.
|
||||
2. Update or add `.claude-plugin/README.md`, `.codex-plugin/README.md`, or `the-shortform-guide.md` as needed.
|
||||
3. Optionally update `package.json` or `scripts/ci/catalog.js` if documentation affects tooling.
|
||||
|
||||
---
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
- **Test Files:** Use the `*.test.js` naming convention.
|
||||
- Example: `mySkill.test.js`
|
||||
- **Framework:** Not explicitly detected; follow standard JavaScript testing practices.
|
||||
- **Location:** Tests are typically located in `tests/` directories, mirroring the structure of the code they test.
|
||||
- **Example:**
|
||||
```js
|
||||
// tests/mySkill.test.js
|
||||
import { mySkill } from '../skills/mySkill.js';
|
||||
|
||||
test('mySkill does something', () => {
|
||||
expect(mySkill()).toBe(true);
|
||||
});
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Purpose |
|
||||
|--------------------|--------------------------------------------------------|
|
||||
| /add-skill | Add or update a skill and register it in manifests |
|
||||
| /add-command | Add or update a command workflow |
|
||||
| /refactor-skill | Refactor skill or agent structure |
|
||||
| /add-install-target| Add or update an install target integration |
|
||||
| /update-hook | Update hooks, automation, or CI/CD workflows |
|
||||
| /update-docs | Sync or update documentation and repo guidance |
|
||||
```
|
||||
|
||||
@@ -10,7 +10,7 @@ Use this workflow when working on **add-or-update-skill** in `everything-claude-
|
||||
|
||||
## Goal
|
||||
|
||||
Adds a new skill or updates an existing skill, including documentation and registration in manifests.
|
||||
Adds a new skill or updates an existing skill in the agents or skills directory, with documentation and registration in manifests.
|
||||
|
||||
## Common Files
|
||||
|
||||
@@ -30,10 +30,11 @@ Adds a new skill or updates an existing skill, including documentation and regis
|
||||
|
||||
## Typical Commit Signals
|
||||
|
||||
- Create or modify SKILL.md in skills/<skill-name>/ or .agents/skills/<skill-name>/
|
||||
- Create or update SKILL.md in skills/[skill-name]/ or .agents/skills/[skill-name]/
|
||||
- Optionally add or update related reference files (e.g., references/*.md, assets/*.py)
|
||||
- Update manifests/install-modules.json and/or manifests/install-components.json to register the skill
|
||||
- Update AGENTS.md, README.md, and docs/zh-CN/AGENTS.md for documentation and agent tables
|
||||
- Optionally add or update reference files or assets under the skill directory
|
||||
- Update AGENTS.md, README.md, and docs/zh-CN/AGENTS.md as needed
|
||||
- If skill is agent-facing, update .agents/skills/[skill-name]/SKILL.md
|
||||
|
||||
## Notes
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
"version": "1.3",
|
||||
"schemaVersion": "1.0",
|
||||
"generatedBy": "ecc-tools",
|
||||
"generatedAt": "2026-04-02T17:50:22.851Z",
|
||||
"generatedAt": "2026-04-02T18:08:28.699Z",
|
||||
"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-02T18:07:47.335Z"
|
||||
"createdAt": "2026-04-02T18:09:33.367Z"
|
||||
}
|
||||
@@ -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, including documentation and registration in manifests.
|
||||
- add-or-update-skill: Adds a new skill or updates an existing skill in the agents or skills directory, with documentation and registration in manifests.
|
||||
|
||||
## Review Reminder
|
||||
|
||||
|
||||
@@ -1,412 +1,150 @@
|
||||
---
|
||||
name: everything-claude-code-conventions
|
||||
description: Development conventions and patterns for everything-claude-code. JavaScript project with conventional commits.
|
||||
---
|
||||
```markdown
|
||||
# everything-claude-code Development Patterns
|
||||
|
||||
# Everything Claude Code Conventions
|
||||
|
||||
> Generated from [affaan-m/everything-claude-code](https://github.com/affaan-m/everything-claude-code) on 2026-04-02
|
||||
> Auto-generated skill from repository analysis
|
||||
|
||||
## Overview
|
||||
|
||||
This skill teaches Claude the development patterns and conventions used in everything-claude-code.
|
||||
This skill provides a comprehensive guide to the development patterns, workflows, and coding conventions used in the `everything-claude-code` repository. It covers how to add or update skills, commands, install targets, hooks, and documentation, as well as the repository's JavaScript coding style and testing patterns. This guide is intended for contributors looking to maintain consistency and efficiency when working within this codebase.
|
||||
|
||||
## Tech Stack
|
||||
## Coding Conventions
|
||||
|
||||
- **Primary Language**: JavaScript
|
||||
- **Architecture**: hybrid module organization
|
||||
- **Test Location**: separate
|
||||
- **Language:** JavaScript (no framework detected)
|
||||
- **File Naming:** Use `camelCase` for JavaScript files and folders.
|
||||
- Example: `mySkill.js`, `installTarget.js`
|
||||
- **Import Style:** Use relative imports.
|
||||
- Example:
|
||||
```js
|
||||
import myUtil from './utils/myUtil.js';
|
||||
```
|
||||
- **Export Style:** Mixed (both default and named exports are used).
|
||||
- Example:
|
||||
```js
|
||||
// Named export
|
||||
export function doSomething() { ... }
|
||||
|
||||
## When to Use This Skill
|
||||
// Default export
|
||||
export default MyComponent;
|
||||
```
|
||||
- **Commit Messages:** Follow [Conventional Commits](https://www.conventionalcommits.org/) with prefixes like `fix`, `feat`, `docs`, `chore`.
|
||||
- Example: `feat: add support for new install target`
|
||||
- **Documentation:** Each skill or command should have a `SKILL.md` or markdown documentation file in its directory.
|
||||
|
||||
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
|
||||
## Workflows
|
||||
|
||||
## Commit Conventions
|
||||
### Add or Update a Skill
|
||||
**Trigger:** When adding or updating a skill for agents or workflows
|
||||
**Command:** `/add-skill`
|
||||
|
||||
Follow these commit message conventions based on 500 analyzed commits.
|
||||
1. Create or update `SKILL.md` in `skills/[skill-name]/` or `.agents/skills/[skill-name]/`.
|
||||
2. Optionally add or update related reference files (e.g., `references/*.md`, `assets/*.py`).
|
||||
3. Register the skill in `manifests/install-modules.json` and/or `manifests/install-components.json`.
|
||||
4. Update `AGENTS.md`, `README.md`, and `docs/zh-CN/AGENTS.md` as needed.
|
||||
5. If the skill is agent-facing, update `.agents/skills/[skill-name]/SKILL.md`.
|
||||
|
||||
### 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-or-update-skill.md)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
refactor: extract social graph ranking core
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix: port safe ci cleanup from backlog
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
docs: close bundle drift and sync plugin guidance
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
chore: ignore local orchestration artifacts
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: 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')
|
||||
**Example:**
|
||||
```json
|
||||
// manifests/install-modules.json
|
||||
{
|
||||
"skills": [
|
||||
"myNewSkill"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Common Workflows
|
||||
---
|
||||
|
||||
These workflows were detected from analyzing commit patterns.
|
||||
### Add or Update a Command Workflow
|
||||
**Trigger:** When introducing or refining a workflow command
|
||||
**Command:** `/add-command`
|
||||
|
||||
### Feature Development
|
||||
1. Create or update a command markdown file in `commands/` or `.claude/commands/`.
|
||||
2. Iterate based on review feedback (fixes, improvements, removal of external links, etc.).
|
||||
3. Update related documentation or references if needed.
|
||||
|
||||
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.*`
|
||||
- `**/api/**`
|
||||
|
||||
**Example commit sequence**:
|
||||
**Example:**
|
||||
```markdown
|
||||
// commands/myCommand.md
|
||||
# My Command
|
||||
Description and usage...
|
||||
```
|
||||
feat(install): add CodeBuddy(Tencent) adaptation with installation scripts (#1038)
|
||||
chore(deps-dev): bump c8 from 10.1.3 to 11.0.0 (#1065)
|
||||
chore(deps): bump actions/checkout from 4.3.1 to 6.0.2 (#1060)
|
||||
```
|
||||
|
||||
### Refactoring
|
||||
|
||||
Code refactoring and cleanup workflow
|
||||
|
||||
**Frequency**: ~4 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 Or Update Skill
|
||||
|
||||
Adds a new skill or updates an existing skill, including documentation and registration in manifests.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or modify SKILL.md in skills/<skill-name>/ or .agents/skills/<skill-name>/
|
||||
2. Update manifests/install-modules.json and/or manifests/install-components.json to register the skill
|
||||
3. Update AGENTS.md, README.md, and docs/zh-CN/AGENTS.md for documentation and agent tables
|
||||
4. Optionally add or update reference files or assets under the skill directory
|
||||
|
||||
**Files typically involved**:
|
||||
- `skills/*/SKILL.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `manifests/install-modules.json`
|
||||
- `manifests/install-components.json`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or modify SKILL.md in skills/<skill-name>/ or .agents/skills/<skill-name>/
|
||||
Update manifests/install-modules.json and/or manifests/install-components.json to register the skill
|
||||
Update AGENTS.md, README.md, and docs/zh-CN/AGENTS.md for documentation and agent tables
|
||||
Optionally add or update reference files or assets under the skill directory
|
||||
```
|
||||
|
||||
### Add Or Update Command
|
||||
|
||||
Adds or updates a workflow command for the Claude agentic system.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or modify a markdown file in commands/ or .claude/commands/
|
||||
2. Document the workflow, arguments, and usage
|
||||
3. Optionally update related documentation (README.md, AGENTS.md, etc.)
|
||||
|
||||
**Files typically involved**:
|
||||
- `commands/*.md`
|
||||
- `.claude/commands/*.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or modify a markdown file in commands/ or .claude/commands/
|
||||
Document the workflow, arguments, and usage
|
||||
Optionally update related documentation (README.md, AGENTS.md, etc.)
|
||||
```
|
||||
|
||||
### Refactor Skill Or Agent Logic
|
||||
|
||||
Refactors core logic or merges/splits skills, updating documentation and manifests accordingly.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit or move SKILL.md files in skills/ or .agents/skills/
|
||||
2. Update manifests/install-modules.json and/or manifests/install-components.json
|
||||
3. Update documentation files (AGENTS.md, README.md, docs/zh-CN/AGENTS.md, etc.)
|
||||
|
||||
**Files typically involved**:
|
||||
- `skills/*/SKILL.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `manifests/install-modules.json`
|
||||
- `manifests/install-components.json`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit or move SKILL.md files in skills/ or .agents/skills/
|
||||
Update manifests/install-modules.json and/or manifests/install-components.json
|
||||
Update documentation files (AGENTS.md, README.md, docs/zh-CN/AGENTS.md, etc.)
|
||||
```
|
||||
|
||||
### Add Or Update Install Target
|
||||
|
||||
Adds or updates an install target (e.g., Gemini, CodeBuddy) including scripts, schemas, and registration.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add new directory and scripts under .<target>/ (e.g., .gemini/, .codebuddy/)
|
||||
2. Update manifests/install-modules.json and schemas/ecc-install-config.schema.json
|
||||
3. Add or update scripts/lib/install-targets/<target>-project.js and registry.js
|
||||
4. Update or add tests for install targets
|
||||
|
||||
**Files typically involved**:
|
||||
- `.<target>/*`
|
||||
- `manifests/install-modules.json`
|
||||
- `schemas/ecc-install-config.schema.json`
|
||||
- `schemas/install-modules.schema.json`
|
||||
- `scripts/lib/install-manifests.js`
|
||||
- `scripts/lib/install-targets/<target>-project.js`
|
||||
- `scripts/lib/install-targets/registry.js`
|
||||
- `tests/lib/install-targets.test.js`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Add new directory and scripts under .<target>/ (e.g., .gemini/, .codebuddy/)
|
||||
Update manifests/install-modules.json and schemas/ecc-install-config.schema.json
|
||||
Add or update scripts/lib/install-targets/<target>-project.js and registry.js
|
||||
Update or add tests for install targets
|
||||
```
|
||||
|
||||
### Documentation Sync And Update
|
||||
|
||||
Synchronizes and updates documentation across multiple files and languages.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit AGENTS.md, README.md, README.zh-CN.md, WORKING-CONTEXT.md
|
||||
2. Edit docs/zh-CN/AGENTS.md, docs/zh-CN/README.md
|
||||
3. Optionally update .agents/skills/*/SKILL.md and related documentation
|
||||
|
||||
**Files typically involved**:
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `WORKING-CONTEXT.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
- `docs/zh-CN/README.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit AGENTS.md, README.md, README.zh-CN.md, WORKING-CONTEXT.md
|
||||
Edit docs/zh-CN/AGENTS.md, docs/zh-CN/README.md
|
||||
Optionally update .agents/skills/*/SKILL.md and related documentation
|
||||
```
|
||||
|
||||
### Update Or Add Hooks And Ci
|
||||
|
||||
Updates or adds new hooks, CI scripts, and related tests for code quality and automation.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit hooks/hooks.json and/or scripts/hooks/*.js
|
||||
2. Update or add tests in tests/hooks/*.test.js or tests/scripts/*.test.js
|
||||
3. Update CI workflow files in .github/workflows/
|
||||
|
||||
**Files typically involved**:
|
||||
- `hooks/hooks.json`
|
||||
- `scripts/hooks/*.js`
|
||||
- `tests/hooks/*.test.js`
|
||||
- `tests/scripts/*.test.js`
|
||||
- `.github/workflows/*.yml`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit hooks/hooks.json and/or scripts/hooks/*.js
|
||||
Update or add tests in tests/hooks/*.test.js or tests/scripts/*.test.js
|
||||
Update CI workflow files in .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.*
|
||||
### Refactor Skill or Agent Structure
|
||||
**Trigger:** When reorganizing skills, merging/splitting logic, or extracting shared code
|
||||
**Command:** `/refactor-skill`
|
||||
|
||||
1. Edit multiple `SKILL.md` files in `skills/` and/or `.agents/skills/`.
|
||||
2. Update `AGENTS.md`, `README.md`, `README.zh-CN.md`, and `docs/zh-CN/*` as needed.
|
||||
3. Update `manifests/install-modules.json` or related manifests.
|
||||
4. Remove or merge obsolete command files.
|
||||
|
||||
---
|
||||
|
||||
### Add or Update Install Target
|
||||
**Trigger:** When supporting a new platform or updating install logic
|
||||
**Command:** `/add-install-target`
|
||||
|
||||
1. Add or update install scripts and documentation under a dot-directory (e.g., `.codebuddy/`, `.gemini/`).
|
||||
2. Update `manifests/install-modules.json` and `schemas/ecc-install-config.schema.json`.
|
||||
3. Update or create scripts in `scripts/lib/install-targets/[target].js`.
|
||||
4. Update `registry.js` and `install-manifests.js` as needed.
|
||||
5. Add or update tests in `tests/lib/install-targets.test.js`.
|
||||
|
||||
**Example:**
|
||||
```js
|
||||
// scripts/lib/install-targets/codeBuddy.js
|
||||
export function installCodeBuddy() { ... }
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Update Hooks and Automation
|
||||
**Trigger:** When improving or fixing hooks, audit logs, or CI/CD automation
|
||||
**Command:** `/update-hook`
|
||||
|
||||
1. Edit `hooks/hooks.json` and/or add/update `scripts/hooks/*.js`.
|
||||
2. Update or add related test files in `tests/hooks/` or `tests/scripts/`.
|
||||
3. Edit `.github/workflows/*.yml` for CI/CD changes.
|
||||
4. Update `package.json` or related config if needed.
|
||||
|
||||
---
|
||||
|
||||
### Documentation Sync and Guidance Update
|
||||
**Trigger:** When updating repo guidance, syncing documentation, or clarifying workflows
|
||||
**Command:** `/update-docs`
|
||||
|
||||
1. Edit one or more of `AGENTS.md`, `README.md`, `README.zh-CN.md`, `WORKING-CONTEXT.md`, and `docs/zh-CN/*`.
|
||||
2. Update or add `.claude-plugin/README.md`, `.codex-plugin/README.md`, or `the-shortform-guide.md` as needed.
|
||||
3. Optionally update `package.json` or `scripts/ci/catalog.js` if documentation affects tooling.
|
||||
|
||||
---
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
- **Test Files:** Use the `*.test.js` naming convention.
|
||||
- Example: `mySkill.test.js`
|
||||
- **Framework:** Not explicitly detected; follow standard JavaScript testing practices.
|
||||
- **Location:** Tests are typically located in `tests/` directories, mirroring the structure of the code they test.
|
||||
- **Example:**
|
||||
```js
|
||||
// tests/mySkill.test.js
|
||||
import { mySkill } from '../skills/mySkill.js';
|
||||
|
||||
test('mySkill does something', () => {
|
||||
expect(mySkill()).toBe(true);
|
||||
});
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Purpose |
|
||||
|--------------------|--------------------------------------------------------|
|
||||
| /add-skill | Add or update a skill and register it in manifests |
|
||||
| /add-command | Add or update a command workflow |
|
||||
| /refactor-skill | Refactor skill or agent structure |
|
||||
| /add-install-target| Add or update an install target integration |
|
||||
| /update-hook | Update hooks, automation, or CI/CD workflows |
|
||||
| /update-docs | Sync or update documentation and repo guidance |
|
||||
```
|
||||
|
||||
@@ -11,5 +11,5 @@
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-or-update-skill.md"
|
||||
],
|
||||
"updatedAt": "2026-04-02T17:50:22.851Z"
|
||||
"updatedAt": "2026-04-02T18:08:28.699Z"
|
||||
}
|
||||
Reference in New Issue
Block a user