mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-04-04 16:23:31 +08:00
Compare commits
10 Commits
ecc-tools/
...
ecc-tools/
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4f50c5d6c9 | ||
|
|
176d8492ce | ||
|
|
2dd24a2c9d | ||
|
|
f6d92d444c | ||
|
|
1f1472f1a2 | ||
|
|
2153a6b9a0 | ||
|
|
577fb1b95f | ||
|
|
cee93d0ec0 | ||
|
|
2a80e98e84 | ||
|
|
3208a0b88e |
@@ -1,90 +1,210 @@
|
||||
```markdown
|
||||
# everything-claude-code Development Patterns
|
||||
---
|
||||
name: everything-claude-code-conventions
|
||||
description: Development conventions and patterns for everything-claude-code. TypeScript project with conventional commits.
|
||||
---
|
||||
|
||||
> Auto-generated skill from repository analysis
|
||||
# Everything Claude Code Conventions
|
||||
|
||||
> Generated from [affaan-m/everything-claude-code](https://github.com/affaan-m/everything-claude-code) on 2026-04-04
|
||||
|
||||
## Overview
|
||||
This skill documents the core development patterns, coding conventions, and workflows used in the `everything-claude-code` TypeScript repository. It is designed to help contributors quickly understand how to write, organize, and extend code in this project, including how to add new skills, commands, agent configurations, and identity files to the ECC (everything-claude-code-conventions) bundle.
|
||||
|
||||
## Coding Conventions
|
||||
This skill teaches Claude the development patterns and conventions used in everything-claude-code.
|
||||
|
||||
### File Naming
|
||||
- Use **camelCase** for file names.
|
||||
- Example: `myFeatureComponent.ts`
|
||||
## Tech Stack
|
||||
|
||||
### Import Style
|
||||
- Use **relative imports** for referencing local modules.
|
||||
- Example:
|
||||
```typescript
|
||||
import { myFunction } from './utils';
|
||||
```
|
||||
- **Primary Language**: TypeScript
|
||||
- **Architecture**: hybrid module organization
|
||||
- **Test Location**: separate
|
||||
|
||||
### Export Style
|
||||
- Use **named exports** for all modules.
|
||||
- Example:
|
||||
```typescript
|
||||
// utils.ts
|
||||
export function myFunction() { /* ... */ }
|
||||
```
|
||||
## When to Use This Skill
|
||||
|
||||
### Commit Messages
|
||||
- Follow the **Conventional Commits** format.
|
||||
- Use the `feat` prefix for new features.
|
||||
- Example:
|
||||
```
|
||||
feat: add support for ECC bundle component auto-registration
|
||||
```
|
||||
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 ECC Bundle Component
|
||||
**Trigger:** When you want to extend or update the ECC bundle with a new capability or configuration (such as adding a skill, command, agent config, or identity file).
|
||||
**Command:** `/add-ecc-bundle-component`
|
||||
Follow these commit message conventions based on 10 analyzed commits.
|
||||
|
||||
1. Create or update a file in one of the ECC bundle directories:
|
||||
- `.claude/skills/`
|
||||
- `.agents/skills/`
|
||||
- `.claude/commands/`
|
||||
- `.claude/identity.json`
|
||||
- `.codex/agents/`
|
||||
2. If adding a skill, create a `SKILL.md` file in the appropriate directory.
|
||||
3. Commit the new or updated file with a message indicating the addition to the ECC bundle.
|
||||
- Example commit message:
|
||||
```
|
||||
feat: add new agent config to ECC bundle
|
||||
```
|
||||
4. Push your changes and open a pull request if required.
|
||||
### Commit Style: Conventional Commits
|
||||
|
||||
**Files commonly involved:**
|
||||
### Prefixes Used
|
||||
|
||||
- `feat`
|
||||
|
||||
### Message Guidelines
|
||||
|
||||
- Average message length: ~82 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/ecc-tools.json)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code ECC bundle (.claude/skills/everything-claude-code/SKILL.md)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code ECC bundle (.agents/skills/everything-claude-code/SKILL.md)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code ECC bundle (.claude/identity.json)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code ECC bundle (.codex/agents/explorer.toml)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code ECC bundle (.codex/agents/reviewer.toml)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code ECC bundle (.codex/agents/docs-researcher.toml)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code ECC bundle (.claude/commands/feature-development.md)
|
||||
```
|
||||
|
||||
## Architecture
|
||||
|
||||
### Project Structure: Single Package
|
||||
|
||||
This project uses **hybrid** module organization.
|
||||
|
||||
### Guidelines
|
||||
|
||||
- This project uses a hybrid organization
|
||||
- Follow existing patterns when adding new code
|
||||
|
||||
## Code Style
|
||||
|
||||
### Language: TypeScript
|
||||
|
||||
### Naming Conventions
|
||||
|
||||
| Element | Convention |
|
||||
|---------|------------|
|
||||
| Files | camelCase |
|
||||
| Functions | camelCase |
|
||||
| Classes | PascalCase |
|
||||
| Constants | SCREAMING_SNAKE_CASE |
|
||||
|
||||
### Import Style: Relative Imports
|
||||
|
||||
### Export Style: Named Exports
|
||||
|
||||
|
||||
*Preferred import style*
|
||||
|
||||
```typescript
|
||||
// Use relative imports
|
||||
import { Button } from '../components/Button'
|
||||
import { useAuth } from './hooks/useAuth'
|
||||
```
|
||||
|
||||
*Preferred export style*
|
||||
|
||||
```typescript
|
||||
// Use named exports
|
||||
export function calculateTotal() { ... }
|
||||
export const TAX_RATE = 0.1
|
||||
export interface Order { ... }
|
||||
```
|
||||
|
||||
## Common Workflows
|
||||
|
||||
These workflows were detected from analyzing commit patterns.
|
||||
|
||||
### Feature Development
|
||||
|
||||
Standard feature implementation workflow
|
||||
|
||||
**Frequency**: ~30 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add feature implementation
|
||||
2. Add tests for feature
|
||||
3. Update documentation
|
||||
|
||||
**Files typically involved**:
|
||||
- `.claude/commands/*`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
feat: add everything-claude-code ECC bundle (.claude/ecc-tools.json)
|
||||
feat: add everything-claude-code ECC bundle (.claude/skills/everything-claude-code/SKILL.md)
|
||||
feat: add everything-claude-code ECC bundle (.agents/skills/everything-claude-code/SKILL.md)
|
||||
```
|
||||
|
||||
### Add Ecc Bundle Component
|
||||
|
||||
Adds a new component to the everything-claude-code ECC bundle by creating or updating a configuration or documentation file in a structured directory.
|
||||
|
||||
**Frequency**: ~10 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or update a file in a relevant ECC bundle directory (e.g., .claude/skills/, .agents/skills/, .claude/commands/, .claude/identity.json, .claude/ecc-tools.json)
|
||||
2. Commit the new or updated file with a descriptive message referencing the ECC bundle
|
||||
|
||||
**Files typically involved**:
|
||||
- `.claude/ecc-tools.json`
|
||||
- `.claude/skills/everything-claude-code/SKILL.md`
|
||||
- `.agents/skills/everything-claude-code/SKILL.md`
|
||||
- `.claude/commands/feature-development.md`
|
||||
- `.claude/commands/add-ecc-bundle-component.md`
|
||||
- `.agents/skills/everything-claude-code/agents/openai.yaml`
|
||||
- `.claude/identity.json`
|
||||
- `.claude/ecc-tools.json`
|
||||
- `.codex/agents/explorer.toml`
|
||||
- `.codex/agents/reviewer.toml`
|
||||
- `.codex/agents/docs-researcher.toml`
|
||||
- `.claude/commands/feature-development.md`
|
||||
- `.claude/commands/add-ecc-bundle-component.md`
|
||||
|
||||
## Testing Patterns
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or update a file in a relevant ECC bundle directory (e.g., .claude/skills/, .agents/skills/, .claude/commands/, .claude/identity.json, .claude/ecc-tools.json)
|
||||
Commit the new or updated file with a descriptive message referencing the ECC bundle
|
||||
```
|
||||
|
||||
- **Test file pattern:** Files should be named with `.test.` in the filename, e.g., `myFeature.test.ts`.
|
||||
- **Testing framework:** Not explicitly detected; check existing test files for patterns.
|
||||
- **Example test file:**
|
||||
```typescript
|
||||
// myFeature.test.ts
|
||||
import { myFunction } from './myFeature';
|
||||
|
||||
describe('myFunction', () => {
|
||||
it('should return expected result', () => {
|
||||
expect(myFunction()).toBe('expected');
|
||||
});
|
||||
});
|
||||
```
|
||||
## Best Practices
|
||||
|
||||
## Commands
|
||||
Based on analysis of the codebase, follow these practices:
|
||||
|
||||
| Command | Purpose |
|
||||
|----------------------------|----------------------------------------------------------------|
|
||||
| /add-ecc-bundle-component | Add or update a skill, command, agent config, or identity file in the ECC bundle |
|
||||
```
|
||||
### Do
|
||||
|
||||
- Use conventional commit format (feat:, fix:, etc.)
|
||||
- Use camelCase for file names
|
||||
- Prefer named exports
|
||||
|
||||
### Don't
|
||||
|
||||
- Don't write vague commit messages
|
||||
- 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.*
|
||||
|
||||
@@ -10,16 +10,16 @@ Use this workflow when working on **add-ecc-bundle-component** in `everything-cl
|
||||
|
||||
## Goal
|
||||
|
||||
Adds a new component to the everything-claude-code-conventions ECC bundle, such as skills, commands, agent configs, or identity files.
|
||||
Adds a new component to the everything-claude-code ECC bundle by creating or updating a configuration or documentation file in a structured directory.
|
||||
|
||||
## Common Files
|
||||
|
||||
- `.claude/ecc-tools.json`
|
||||
- `.claude/skills/everything-claude-code/SKILL.md`
|
||||
- `.agents/skills/everything-claude-code/SKILL.md`
|
||||
- `.claude/commands/feature-development.md`
|
||||
- `.claude/commands/add-ecc-bundle-component.md`
|
||||
- `.agents/skills/everything-claude-code/agents/openai.yaml`
|
||||
- `.claude/identity.json`
|
||||
- `.claude/ecc-tools.json`
|
||||
- `.codex/agents/explorer.toml`
|
||||
|
||||
## Suggested Sequence
|
||||
|
||||
@@ -30,8 +30,8 @@ Adds a new component to the everything-claude-code-conventions ECC bundle, such
|
||||
|
||||
## Typical Commit Signals
|
||||
|
||||
- Create or update a file in one of the ECC bundle directories (e.g., .claude/skills/, .agents/skills/, .claude/commands/, .claude/identity.json, .codex/agents/).
|
||||
- Commit the new or updated file with a message indicating addition to the ECC bundle.
|
||||
- Create or update a file in a relevant ECC bundle directory (e.g., .claude/skills/, .agents/skills/, .claude/commands/, .claude/identity.json, .claude/ecc-tools.json)
|
||||
- Commit the new or updated file with a descriptive message referencing the ECC bundle
|
||||
|
||||
## Notes
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
"version": "1.3",
|
||||
"schemaVersion": "1.0",
|
||||
"generatedBy": "ecc-tools",
|
||||
"generatedAt": "2026-04-04T06:24:30.422Z",
|
||||
"generatedAt": "2026-04-04T04:38:41.703Z",
|
||||
"repo": "https://github.com/affaan-m/everything-claude-code",
|
||||
"profiles": {
|
||||
"requested": "developer",
|
||||
|
||||
@@ -10,5 +10,5 @@
|
||||
"typescript"
|
||||
],
|
||||
"suggestedBy": "ecc-tools-repo-analysis",
|
||||
"createdAt": "2026-04-04T06:24:42.776Z"
|
||||
"createdAt": "2026-04-04T06:24:04.711Z"
|
||||
}
|
||||
@@ -1,90 +1,210 @@
|
||||
```markdown
|
||||
# everything-claude-code Development Patterns
|
||||
---
|
||||
name: everything-claude-code-conventions
|
||||
description: Development conventions and patterns for everything-claude-code. TypeScript project with conventional commits.
|
||||
---
|
||||
|
||||
> Auto-generated skill from repository analysis
|
||||
# Everything Claude Code Conventions
|
||||
|
||||
> Generated from [affaan-m/everything-claude-code](https://github.com/affaan-m/everything-claude-code) on 2026-04-04
|
||||
|
||||
## Overview
|
||||
This skill documents the core development patterns, coding conventions, and workflows used in the `everything-claude-code` TypeScript repository. It is designed to help contributors quickly understand how to write, organize, and extend code in this project, including how to add new skills, commands, agent configurations, and identity files to the ECC (everything-claude-code-conventions) bundle.
|
||||
|
||||
## Coding Conventions
|
||||
This skill teaches Claude the development patterns and conventions used in everything-claude-code.
|
||||
|
||||
### File Naming
|
||||
- Use **camelCase** for file names.
|
||||
- Example: `myFeatureComponent.ts`
|
||||
## Tech Stack
|
||||
|
||||
### Import Style
|
||||
- Use **relative imports** for referencing local modules.
|
||||
- Example:
|
||||
```typescript
|
||||
import { myFunction } from './utils';
|
||||
```
|
||||
- **Primary Language**: TypeScript
|
||||
- **Architecture**: hybrid module organization
|
||||
- **Test Location**: separate
|
||||
|
||||
### Export Style
|
||||
- Use **named exports** for all modules.
|
||||
- Example:
|
||||
```typescript
|
||||
// utils.ts
|
||||
export function myFunction() { /* ... */ }
|
||||
```
|
||||
## When to Use This Skill
|
||||
|
||||
### Commit Messages
|
||||
- Follow the **Conventional Commits** format.
|
||||
- Use the `feat` prefix for new features.
|
||||
- Example:
|
||||
```
|
||||
feat: add support for ECC bundle component auto-registration
|
||||
```
|
||||
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 ECC Bundle Component
|
||||
**Trigger:** When you want to extend or update the ECC bundle with a new capability or configuration (such as adding a skill, command, agent config, or identity file).
|
||||
**Command:** `/add-ecc-bundle-component`
|
||||
Follow these commit message conventions based on 10 analyzed commits.
|
||||
|
||||
1. Create or update a file in one of the ECC bundle directories:
|
||||
- `.claude/skills/`
|
||||
- `.agents/skills/`
|
||||
- `.claude/commands/`
|
||||
- `.claude/identity.json`
|
||||
- `.codex/agents/`
|
||||
2. If adding a skill, create a `SKILL.md` file in the appropriate directory.
|
||||
3. Commit the new or updated file with a message indicating the addition to the ECC bundle.
|
||||
- Example commit message:
|
||||
```
|
||||
feat: add new agent config to ECC bundle
|
||||
```
|
||||
4. Push your changes and open a pull request if required.
|
||||
### Commit Style: Conventional Commits
|
||||
|
||||
**Files commonly involved:**
|
||||
### Prefixes Used
|
||||
|
||||
- `feat`
|
||||
|
||||
### Message Guidelines
|
||||
|
||||
- Average message length: ~82 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/ecc-tools.json)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code ECC bundle (.claude/skills/everything-claude-code/SKILL.md)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code ECC bundle (.agents/skills/everything-claude-code/SKILL.md)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code ECC bundle (.claude/identity.json)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code ECC bundle (.codex/agents/explorer.toml)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code ECC bundle (.codex/agents/reviewer.toml)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code ECC bundle (.codex/agents/docs-researcher.toml)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code ECC bundle (.claude/commands/feature-development.md)
|
||||
```
|
||||
|
||||
## Architecture
|
||||
|
||||
### Project Structure: Single Package
|
||||
|
||||
This project uses **hybrid** module organization.
|
||||
|
||||
### Guidelines
|
||||
|
||||
- This project uses a hybrid organization
|
||||
- Follow existing patterns when adding new code
|
||||
|
||||
## Code Style
|
||||
|
||||
### Language: TypeScript
|
||||
|
||||
### Naming Conventions
|
||||
|
||||
| Element | Convention |
|
||||
|---------|------------|
|
||||
| Files | camelCase |
|
||||
| Functions | camelCase |
|
||||
| Classes | PascalCase |
|
||||
| Constants | SCREAMING_SNAKE_CASE |
|
||||
|
||||
### Import Style: Relative Imports
|
||||
|
||||
### Export Style: Named Exports
|
||||
|
||||
|
||||
*Preferred import style*
|
||||
|
||||
```typescript
|
||||
// Use relative imports
|
||||
import { Button } from '../components/Button'
|
||||
import { useAuth } from './hooks/useAuth'
|
||||
```
|
||||
|
||||
*Preferred export style*
|
||||
|
||||
```typescript
|
||||
// Use named exports
|
||||
export function calculateTotal() { ... }
|
||||
export const TAX_RATE = 0.1
|
||||
export interface Order { ... }
|
||||
```
|
||||
|
||||
## Common Workflows
|
||||
|
||||
These workflows were detected from analyzing commit patterns.
|
||||
|
||||
### Feature Development
|
||||
|
||||
Standard feature implementation workflow
|
||||
|
||||
**Frequency**: ~30 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add feature implementation
|
||||
2. Add tests for feature
|
||||
3. Update documentation
|
||||
|
||||
**Files typically involved**:
|
||||
- `.claude/commands/*`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
feat: add everything-claude-code ECC bundle (.claude/ecc-tools.json)
|
||||
feat: add everything-claude-code ECC bundle (.claude/skills/everything-claude-code/SKILL.md)
|
||||
feat: add everything-claude-code ECC bundle (.agents/skills/everything-claude-code/SKILL.md)
|
||||
```
|
||||
|
||||
### Add Ecc Bundle Component
|
||||
|
||||
Adds a new component to the everything-claude-code ECC bundle by creating or updating a configuration or documentation file in a structured directory.
|
||||
|
||||
**Frequency**: ~10 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or update a file in a relevant ECC bundle directory (e.g., .claude/skills/, .agents/skills/, .claude/commands/, .claude/identity.json, .claude/ecc-tools.json)
|
||||
2. Commit the new or updated file with a descriptive message referencing the ECC bundle
|
||||
|
||||
**Files typically involved**:
|
||||
- `.claude/ecc-tools.json`
|
||||
- `.claude/skills/everything-claude-code/SKILL.md`
|
||||
- `.agents/skills/everything-claude-code/SKILL.md`
|
||||
- `.claude/commands/feature-development.md`
|
||||
- `.claude/commands/add-ecc-bundle-component.md`
|
||||
- `.agents/skills/everything-claude-code/agents/openai.yaml`
|
||||
- `.claude/identity.json`
|
||||
- `.claude/ecc-tools.json`
|
||||
- `.codex/agents/explorer.toml`
|
||||
- `.codex/agents/reviewer.toml`
|
||||
- `.codex/agents/docs-researcher.toml`
|
||||
- `.claude/commands/feature-development.md`
|
||||
- `.claude/commands/add-ecc-bundle-component.md`
|
||||
|
||||
## Testing Patterns
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or update a file in a relevant ECC bundle directory (e.g., .claude/skills/, .agents/skills/, .claude/commands/, .claude/identity.json, .claude/ecc-tools.json)
|
||||
Commit the new or updated file with a descriptive message referencing the ECC bundle
|
||||
```
|
||||
|
||||
- **Test file pattern:** Files should be named with `.test.` in the filename, e.g., `myFeature.test.ts`.
|
||||
- **Testing framework:** Not explicitly detected; check existing test files for patterns.
|
||||
- **Example test file:**
|
||||
```typescript
|
||||
// myFeature.test.ts
|
||||
import { myFunction } from './myFeature';
|
||||
|
||||
describe('myFunction', () => {
|
||||
it('should return expected result', () => {
|
||||
expect(myFunction()).toBe('expected');
|
||||
});
|
||||
});
|
||||
```
|
||||
## Best Practices
|
||||
|
||||
## Commands
|
||||
Based on analysis of the codebase, follow these practices:
|
||||
|
||||
| Command | Purpose |
|
||||
|----------------------------|----------------------------------------------------------------|
|
||||
| /add-ecc-bundle-component | Add or update a skill, command, agent config, or identity file in the ECC bundle |
|
||||
```
|
||||
### Do
|
||||
|
||||
- Use conventional commit format (feat:, fix:, etc.)
|
||||
- Use camelCase for file names
|
||||
- Prefer named exports
|
||||
|
||||
### Don't
|
||||
|
||||
- Don't write vague commit messages
|
||||
- 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.*
|
||||
|
||||
Reference in New Issue
Block a user