mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-04-05 16:53:29 +08:00
Compare commits
10 Commits
ecc-tools/
...
ecc-tools/
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2456ae913e | ||
|
|
22ea2d4386 | ||
|
|
88fa013ba2 | ||
|
|
ac052990fa | ||
|
|
562de3cc26 | ||
|
|
d879778337 | ||
|
|
27fc73be83 | ||
|
|
ed6592d1ae | ||
|
|
7a0d7c61f1 | ||
|
|
3e1bac23d1 |
@@ -1,97 +1,209 @@
|
||||
```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 introduces the development conventions and workflows used in the `everything-claude-code` TypeScript repository. It covers file organization, code style, commit patterns, and the process for adding new ECC (everything-claude-code-conventions) bundle components. By following these guidelines, contributors can maintain consistency and streamline collaboration.
|
||||
|
||||
## Coding Conventions
|
||||
This skill teaches Claude the development patterns and conventions used in everything-claude-code.
|
||||
|
||||
### File Naming
|
||||
- Use **camelCase** for file names.
|
||||
- Example: `myComponent.ts`, `userProfile.test.ts`
|
||||
## Tech Stack
|
||||
|
||||
### Import Style
|
||||
- Use **relative imports** for referencing modules.
|
||||
- Example:
|
||||
```typescript
|
||||
import { myFunction } from './utils';
|
||||
```
|
||||
- **Primary Language**: TypeScript
|
||||
- **Architecture**: hybrid module organization
|
||||
- **Test Location**: separate
|
||||
|
||||
### Export Style
|
||||
- Use **named exports** instead of default exports.
|
||||
- Example:
|
||||
```typescript
|
||||
// utils.ts
|
||||
export function myFunction() { /* ... */ }
|
||||
```
|
||||
## When to Use This Skill
|
||||
|
||||
```typescript
|
||||
// usage
|
||||
import { myFunction } from './utils';
|
||||
```
|
||||
Activate this skill when:
|
||||
- Making changes to this repository
|
||||
- Adding new features following established patterns
|
||||
- Writing tests that match project conventions
|
||||
- Creating commits with proper message format
|
||||
|
||||
### Commit Patterns
|
||||
- Follow **conventional commits** with the `feat` prefix for new features.
|
||||
- Example:
|
||||
```
|
||||
feat: add ECC bundle component for agent identity management
|
||||
```
|
||||
- Average commit message length: ~94 characters.
|
||||
## Commit Conventions
|
||||
|
||||
## Workflows
|
||||
Follow these commit message conventions based on 10 analyzed commits.
|
||||
|
||||
### Add ECC Bundle Component
|
||||
**Trigger:** When you want to add a new ECC bundle component (tool, skill, agent, identity, or command) to the repository.
|
||||
**Command:** `/add-ecc-bundle-component`
|
||||
### Commit Style: Conventional Commits
|
||||
|
||||
1. **Create or update** a file in the relevant subdirectory:
|
||||
- For tools: `.claude/ecc-tools.json`
|
||||
- For skills: `.claude/skills/everything-claude-code/SKILL.md` or `.agents/skills/everything-claude-code/SKILL.md`
|
||||
- For identity: `.claude/identity.json`
|
||||
- For commands: `.claude/commands/feature-development.md`, `.claude/commands/add-ecc-bundle-component.md`
|
||||
2. **Commit** the file with a message referencing the ECC bundle.
|
||||
- Example:
|
||||
```
|
||||
feat: add new agent skill to ECC bundle
|
||||
```
|
||||
3. **Repeat** for each new component type as needed.
|
||||
### Prefixes Used
|
||||
|
||||
#### Example: Adding a New Skill
|
||||
```bash
|
||||
# Create the SKILL.md file for the new skill
|
||||
touch .claude/skills/everything-claude-code/SKILL.md
|
||||
- `feat`
|
||||
|
||||
# Edit the file with the skill documentation
|
||||
### Message Guidelines
|
||||
|
||||
# Commit your changes
|
||||
git add .claude/skills/everything-claude-code/SKILL.md
|
||||
git commit -m "feat: add new skill documentation to ECC bundle"
|
||||
git push
|
||||
- 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)
|
||||
```
|
||||
|
||||
## Testing Patterns
|
||||
*Commit message example*
|
||||
|
||||
- **Test files** follow the `*.test.*` pattern (e.g., `userProfile.test.ts`).
|
||||
- **Testing framework** is not explicitly specified.
|
||||
- Place test files alongside the modules they test or in a dedicated test directory.
|
||||
```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*
|
||||
|
||||
#### Example Test File
|
||||
```typescript
|
||||
// userProfile.test.ts
|
||||
import { getUserProfile } from './userProfile';
|
||||
|
||||
describe('getUserProfile', () => {
|
||||
it('should return user data for valid ID', () => {
|
||||
// test implementation
|
||||
});
|
||||
});
|
||||
// Use relative imports
|
||||
import { Button } from '../components/Button'
|
||||
import { useAuth } from './hooks/useAuth'
|
||||
```
|
||||
|
||||
## Commands
|
||||
*Preferred export style*
|
||||
|
||||
| Command | Purpose |
|
||||
|----------------------------|-------------------------------------------------------|
|
||||
| /add-ecc-bundle-component | Add a new ECC bundle component (tool, skill, etc.) |
|
||||
```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, such as a skill, agent, identity, or command.
|
||||
|
||||
**Frequency**: ~8 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or update a file under a specific ECC-related directory (e.g., .claude/skills/, .agents/skills/, .claude/commands/, .claude/identity.json, .claude/ecc-tools.json, .codex/agents/)
|
||||
2. Commit the new or updated file with a message referencing the ECC bundle
|
||||
|
||||
**Files typically involved**:
|
||||
- `.claude/skills/everything-claude-code/SKILL.md`
|
||||
- `.agents/skills/everything-claude-code/SKILL.md`
|
||||
- `.claude/identity.json`
|
||||
- `.claude/ecc-tools.json`
|
||||
- `.claude/commands/feature-development.md`
|
||||
- `.claude/commands/add-ecc-bundle-component.md`
|
||||
- `.codex/agents/explorer.toml`
|
||||
- `.codex/agents/reviewer.toml`
|
||||
- `.codex/agents/docs-researcher.toml`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or update a file under a specific ECC-related directory (e.g., .claude/skills/, .agents/skills/, .claude/commands/, .claude/identity.json, .claude/ecc-tools.json, .codex/agents/)
|
||||
Commit the new or updated file with a message referencing the ECC bundle
|
||||
```
|
||||
|
||||
|
||||
## Best Practices
|
||||
|
||||
Based on analysis of the codebase, follow these practices:
|
||||
|
||||
### 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,14 +10,14 @@ 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 by creating or updating a configuration or documentation file in a specific subdirectory.
|
||||
Adds a new component to the everything-claude-code ECC bundle, such as a skill, agent, identity, or command.
|
||||
|
||||
## Common Files
|
||||
|
||||
- `.claude/ecc-tools.json`
|
||||
- `.claude/skills/everything-claude-code/SKILL.md`
|
||||
- `.agents/skills/everything-claude-code/SKILL.md`
|
||||
- `.claude/identity.json`
|
||||
- `.claude/ecc-tools.json`
|
||||
- `.claude/commands/feature-development.md`
|
||||
- `.claude/commands/add-ecc-bundle-component.md`
|
||||
|
||||
@@ -30,9 +30,8 @@ Adds a new component to the everything-claude-code-conventions ECC bundle by cre
|
||||
|
||||
## Typical Commit Signals
|
||||
|
||||
- Create or update a file in a relevant subdirectory under .claude/, .agents/, or .codex/
|
||||
- Commit the file with a message referencing the ECC bundle
|
||||
- Repeat for each new component type as needed
|
||||
- Create or update a file under a specific ECC-related directory (e.g., .claude/skills/, .agents/skills/, .claude/commands/, .claude/identity.json, .claude/ecc-tools.json, .codex/agents/)
|
||||
- Commit the new or updated file with a message referencing the ECC bundle
|
||||
|
||||
## Notes
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
"version": "1.3",
|
||||
"schemaVersion": "1.0",
|
||||
"generatedBy": "ecc-tools",
|
||||
"generatedAt": "2026-04-04T17:44:46.589Z",
|
||||
"generatedAt": "2026-04-04T17:34:14.896Z",
|
||||
"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-04T17:45:04.390Z"
|
||||
"createdAt": "2026-04-04T17:44:21.263Z"
|
||||
}
|
||||
@@ -1,97 +1,209 @@
|
||||
```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 introduces the development conventions and workflows used in the `everything-claude-code` TypeScript repository. It covers file organization, code style, commit patterns, and the process for adding new ECC (everything-claude-code-conventions) bundle components. By following these guidelines, contributors can maintain consistency and streamline collaboration.
|
||||
|
||||
## Coding Conventions
|
||||
This skill teaches Claude the development patterns and conventions used in everything-claude-code.
|
||||
|
||||
### File Naming
|
||||
- Use **camelCase** for file names.
|
||||
- Example: `myComponent.ts`, `userProfile.test.ts`
|
||||
## Tech Stack
|
||||
|
||||
### Import Style
|
||||
- Use **relative imports** for referencing modules.
|
||||
- Example:
|
||||
```typescript
|
||||
import { myFunction } from './utils';
|
||||
```
|
||||
- **Primary Language**: TypeScript
|
||||
- **Architecture**: hybrid module organization
|
||||
- **Test Location**: separate
|
||||
|
||||
### Export Style
|
||||
- Use **named exports** instead of default exports.
|
||||
- Example:
|
||||
```typescript
|
||||
// utils.ts
|
||||
export function myFunction() { /* ... */ }
|
||||
```
|
||||
## When to Use This Skill
|
||||
|
||||
```typescript
|
||||
// usage
|
||||
import { myFunction } from './utils';
|
||||
```
|
||||
Activate this skill when:
|
||||
- Making changes to this repository
|
||||
- Adding new features following established patterns
|
||||
- Writing tests that match project conventions
|
||||
- Creating commits with proper message format
|
||||
|
||||
### Commit Patterns
|
||||
- Follow **conventional commits** with the `feat` prefix for new features.
|
||||
- Example:
|
||||
```
|
||||
feat: add ECC bundle component for agent identity management
|
||||
```
|
||||
- Average commit message length: ~94 characters.
|
||||
## Commit Conventions
|
||||
|
||||
## Workflows
|
||||
Follow these commit message conventions based on 10 analyzed commits.
|
||||
|
||||
### Add ECC Bundle Component
|
||||
**Trigger:** When you want to add a new ECC bundle component (tool, skill, agent, identity, or command) to the repository.
|
||||
**Command:** `/add-ecc-bundle-component`
|
||||
### Commit Style: Conventional Commits
|
||||
|
||||
1. **Create or update** a file in the relevant subdirectory:
|
||||
- For tools: `.claude/ecc-tools.json`
|
||||
- For skills: `.claude/skills/everything-claude-code/SKILL.md` or `.agents/skills/everything-claude-code/SKILL.md`
|
||||
- For identity: `.claude/identity.json`
|
||||
- For commands: `.claude/commands/feature-development.md`, `.claude/commands/add-ecc-bundle-component.md`
|
||||
2. **Commit** the file with a message referencing the ECC bundle.
|
||||
- Example:
|
||||
```
|
||||
feat: add new agent skill to ECC bundle
|
||||
```
|
||||
3. **Repeat** for each new component type as needed.
|
||||
### Prefixes Used
|
||||
|
||||
#### Example: Adding a New Skill
|
||||
```bash
|
||||
# Create the SKILL.md file for the new skill
|
||||
touch .claude/skills/everything-claude-code/SKILL.md
|
||||
- `feat`
|
||||
|
||||
# Edit the file with the skill documentation
|
||||
### Message Guidelines
|
||||
|
||||
# Commit your changes
|
||||
git add .claude/skills/everything-claude-code/SKILL.md
|
||||
git commit -m "feat: add new skill documentation to ECC bundle"
|
||||
git push
|
||||
- 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)
|
||||
```
|
||||
|
||||
## Testing Patterns
|
||||
*Commit message example*
|
||||
|
||||
- **Test files** follow the `*.test.*` pattern (e.g., `userProfile.test.ts`).
|
||||
- **Testing framework** is not explicitly specified.
|
||||
- Place test files alongside the modules they test or in a dedicated test directory.
|
||||
```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*
|
||||
|
||||
#### Example Test File
|
||||
```typescript
|
||||
// userProfile.test.ts
|
||||
import { getUserProfile } from './userProfile';
|
||||
|
||||
describe('getUserProfile', () => {
|
||||
it('should return user data for valid ID', () => {
|
||||
// test implementation
|
||||
});
|
||||
});
|
||||
// Use relative imports
|
||||
import { Button } from '../components/Button'
|
||||
import { useAuth } from './hooks/useAuth'
|
||||
```
|
||||
|
||||
## Commands
|
||||
*Preferred export style*
|
||||
|
||||
| Command | Purpose |
|
||||
|----------------------------|-------------------------------------------------------|
|
||||
| /add-ecc-bundle-component | Add a new ECC bundle component (tool, skill, etc.) |
|
||||
```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, such as a skill, agent, identity, or command.
|
||||
|
||||
**Frequency**: ~8 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or update a file under a specific ECC-related directory (e.g., .claude/skills/, .agents/skills/, .claude/commands/, .claude/identity.json, .claude/ecc-tools.json, .codex/agents/)
|
||||
2. Commit the new or updated file with a message referencing the ECC bundle
|
||||
|
||||
**Files typically involved**:
|
||||
- `.claude/skills/everything-claude-code/SKILL.md`
|
||||
- `.agents/skills/everything-claude-code/SKILL.md`
|
||||
- `.claude/identity.json`
|
||||
- `.claude/ecc-tools.json`
|
||||
- `.claude/commands/feature-development.md`
|
||||
- `.claude/commands/add-ecc-bundle-component.md`
|
||||
- `.codex/agents/explorer.toml`
|
||||
- `.codex/agents/reviewer.toml`
|
||||
- `.codex/agents/docs-researcher.toml`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or update a file under a specific ECC-related directory (e.g., .claude/skills/, .agents/skills/, .claude/commands/, .claude/identity.json, .claude/ecc-tools.json, .codex/agents/)
|
||||
Commit the new or updated file with a message referencing the ECC bundle
|
||||
```
|
||||
|
||||
|
||||
## Best Practices
|
||||
|
||||
Based on analysis of the codebase, follow these practices:
|
||||
|
||||
### 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