mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-04-03 23:53:29 +08:00
Compare commits
10 Commits
ecc-tools/
...
ecc-tools/
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2951e59b5e | ||
|
|
e1041717e9 | ||
|
|
6358663c16 | ||
|
|
44a7d9327e | ||
|
|
53e70df777 | ||
|
|
1f6dbeaa91 | ||
|
|
eeaa8274d8 | ||
|
|
56e16f0ab8 | ||
|
|
2ec122e38a | ||
|
|
dfacdbcfe9 |
@@ -1,165 +1,55 @@
|
||||
---
|
||||
name: everything-claude-code-conventions
|
||||
description: Development conventions and patterns for everything-claude-code. TypeScript 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-03
|
||||
> Auto-generated skill from repository analysis
|
||||
|
||||
## Overview
|
||||
The `everything-claude-code` repository is a TypeScript codebase focused on modular, convention-driven development without reliance on a specific framework. It emphasizes clear, maintainable code and structured workflows for extending the ECC (everything-claude-code-conventions) bundle with new tools, skills, identity definitions, and commands.
|
||||
|
||||
This skill teaches Claude the development patterns and conventions used in everything-claude-code.
|
||||
## Coding Conventions
|
||||
|
||||
## Tech Stack
|
||||
### File Naming
|
||||
- Use **camelCase** for file names.
|
||||
- Example: `myComponent.ts`, `userProfile.test.ts`
|
||||
|
||||
- **Primary Language**: TypeScript
|
||||
- **Architecture**: hybrid module organization
|
||||
- **Test Location**: separate
|
||||
### Import Style
|
||||
- Use **relative imports** for internal modules.
|
||||
```typescript
|
||||
import { myFunction } from './utils';
|
||||
```
|
||||
|
||||
## When to Use This Skill
|
||||
### Export Style
|
||||
- Use **named exports** for all modules.
|
||||
```typescript
|
||||
// Good
|
||||
export function doSomething() { ... }
|
||||
|
||||
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
|
||||
// Avoid default exports
|
||||
// export default function() { ... }
|
||||
```
|
||||
|
||||
## Commit Conventions
|
||||
### Commit Messages
|
||||
- Follow **conventional commit** style.
|
||||
- Use the `feat` prefix for new features.
|
||||
- Example: `feat: add user authentication module`
|
||||
|
||||
Follow these commit message conventions based on 10 analyzed commits.
|
||||
## Workflows
|
||||
|
||||
### Commit Style: Conventional Commits
|
||||
### Add ECC Bundle Component
|
||||
**Trigger:** When someone wants to extend the ECC bundle with a new convention, tool, skill, or command.
|
||||
**Command:** `/add-ecc-bundle-component`
|
||||
|
||||
### Prefixes Used
|
||||
1. **Identify** the type of component to add (tool, skill, identity, command).
|
||||
2. **Create or update** the relevant file in the appropriate directory:
|
||||
- Tools: `.claude/ecc-tools.json`
|
||||
- Skills: `.claude/skills/everything-claude-code/SKILL.md` or `.agents/skills/everything-claude-code/SKILL.md`
|
||||
- Identity: `.claude/identity.json`
|
||||
- Commands: `.claude/commands/*.md`
|
||||
3. **Commit** the changes with a message indicating the addition to the ECC bundle.
|
||||
- Example: `feat: add new skill to ECC bundle`
|
||||
4. **Push** your changes and open a pull request if required.
|
||||
|
||||
- `feat`
|
||||
|
||||
### Message Guidelines
|
||||
|
||||
- Average message length: ~94 characters
|
||||
- Keep first line concise and descriptive
|
||||
- Use imperative mood ("Add feature" not "Added feature")
|
||||
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code-conventions ECC bundle (.claude/ecc-tools.json)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code-conventions ECC bundle (.claude/identity.json)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code-conventions ECC bundle (.codex/agents/explorer.toml)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code-conventions ECC bundle (.codex/agents/reviewer.toml)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code-conventions ECC bundle (.codex/agents/docs-researcher.toml)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code-conventions 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-conventions ECC bundle (.claude/ecc-tools.json)
|
||||
feat: add everything-claude-code-conventions ECC bundle (.claude/skills/everything-claude-code/SKILL.md)
|
||||
feat: add everything-claude-code-conventions ECC bundle (.agents/skills/everything-claude-code/SKILL.md)
|
||||
```
|
||||
|
||||
### Add Ecc Bundle Component
|
||||
|
||||
Adds a new component to the everything-claude-code-conventions ECC bundle, such as a tool definition, skill file, identity, or command documentation.
|
||||
|
||||
**Frequency**: ~5 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or update a file under a relevant ECC bundle directory (e.g., .claude/ecc-tools.json, .claude/skills/everything-claude-code/SKILL.md, .agents/skills/everything-claude-code/SKILL.md, .claude/identity.json, .claude/commands/*.md)
|
||||
2. Commit the file with a message indicating addition to the ECC bundle
|
||||
|
||||
**Files typically involved**:
|
||||
**Files Involved:**
|
||||
- `.claude/ecc-tools.json`
|
||||
- `.claude/skills/everything-claude-code/SKILL.md`
|
||||
- `.agents/skills/everything-claude-code/SKILL.md`
|
||||
@@ -167,28 +57,38 @@ Adds a new component to the everything-claude-code-conventions ECC bundle, such
|
||||
- `.claude/commands/feature-development.md`
|
||||
- `.claude/commands/add-ecc-bundle-component.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or update a file under a relevant ECC bundle directory (e.g., .claude/ecc-tools.json, .claude/skills/everything-claude-code/SKILL.md, .agents/skills/everything-claude-code/SKILL.md, .claude/identity.json, .claude/commands/*.md)
|
||||
Commit the file with a message indicating addition to the ECC bundle
|
||||
#### Example: Adding a New Skill
|
||||
|
||||
1. Create a new skill file: `.claude/skills/everything-claude-code/myNewSkill.md`
|
||||
2. Add documentation and usage details.
|
||||
3. Commit:
|
||||
```
|
||||
feat: add myNewSkill to ECC bundle
|
||||
```
|
||||
4. Push and submit for review.
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
- **Test files** use the pattern: `*.test.*`
|
||||
- Example: `userProfile.test.ts`
|
||||
- **Testing framework** is not explicitly defined; follow the existing test file structure.
|
||||
- Place tests alongside the modules they test or in a dedicated `tests/` directory if present.
|
||||
|
||||
```typescript
|
||||
// Example test file: userProfile.test.ts
|
||||
import { getUserProfile } from './userProfile';
|
||||
|
||||
describe('getUserProfile', () => {
|
||||
it('returns correct profile data', () => {
|
||||
// test implementation
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
## Best Practices
|
||||
| Command | Purpose |
|
||||
|----------------------------|-----------------------------------------------------------------|
|
||||
| /add-ecc-bundle-component | Add a new tool, skill, identity, or command to the ECC bundle |
|
||||
|
||||
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,7 +10,7 @@ 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 a tool definition, skill file, identity, or command documentation.
|
||||
Adds a new component to the everything-claude-code-conventions ECC bundle, such as tools, skills, identity, or commands.
|
||||
|
||||
## Common Files
|
||||
|
||||
@@ -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 under a relevant ECC bundle directory (e.g., .claude/ecc-tools.json, .claude/skills/everything-claude-code/SKILL.md, .agents/skills/everything-claude-code/SKILL.md, .claude/identity.json, .claude/commands/*.md)
|
||||
- Commit the file with a message indicating addition to the ECC bundle
|
||||
- Create or update a file in the appropriate ECC bundle directory (e.g., .claude/ecc-tools.json, .claude/skills/everything-claude-code/SKILL.md, .agents/skills/everything-claude-code/SKILL.md, .claude/identity.json, .claude/commands/*.md).
|
||||
- Commit the file with a message indicating addition to the ECC bundle.
|
||||
|
||||
## Notes
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
"version": "1.3",
|
||||
"schemaVersion": "1.0",
|
||||
"generatedBy": "ecc-tools",
|
||||
"generatedAt": "2026-04-03T10:14:32.602Z",
|
||||
"generatedAt": "2026-04-03T12:33:56.782Z",
|
||||
"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-03T12:33:26.494Z"
|
||||
"createdAt": "2026-04-03T12:34:16.065Z"
|
||||
}
|
||||
@@ -1,165 +1,55 @@
|
||||
---
|
||||
name: everything-claude-code-conventions
|
||||
description: Development conventions and patterns for everything-claude-code. TypeScript 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-03
|
||||
> Auto-generated skill from repository analysis
|
||||
|
||||
## Overview
|
||||
The `everything-claude-code` repository is a TypeScript codebase focused on modular, convention-driven development without reliance on a specific framework. It emphasizes clear, maintainable code and structured workflows for extending the ECC (everything-claude-code-conventions) bundle with new tools, skills, identity definitions, and commands.
|
||||
|
||||
This skill teaches Claude the development patterns and conventions used in everything-claude-code.
|
||||
## Coding Conventions
|
||||
|
||||
## Tech Stack
|
||||
### File Naming
|
||||
- Use **camelCase** for file names.
|
||||
- Example: `myComponent.ts`, `userProfile.test.ts`
|
||||
|
||||
- **Primary Language**: TypeScript
|
||||
- **Architecture**: hybrid module organization
|
||||
- **Test Location**: separate
|
||||
### Import Style
|
||||
- Use **relative imports** for internal modules.
|
||||
```typescript
|
||||
import { myFunction } from './utils';
|
||||
```
|
||||
|
||||
## When to Use This Skill
|
||||
### Export Style
|
||||
- Use **named exports** for all modules.
|
||||
```typescript
|
||||
// Good
|
||||
export function doSomething() { ... }
|
||||
|
||||
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
|
||||
// Avoid default exports
|
||||
// export default function() { ... }
|
||||
```
|
||||
|
||||
## Commit Conventions
|
||||
### Commit Messages
|
||||
- Follow **conventional commit** style.
|
||||
- Use the `feat` prefix for new features.
|
||||
- Example: `feat: add user authentication module`
|
||||
|
||||
Follow these commit message conventions based on 10 analyzed commits.
|
||||
## Workflows
|
||||
|
||||
### Commit Style: Conventional Commits
|
||||
### Add ECC Bundle Component
|
||||
**Trigger:** When someone wants to extend the ECC bundle with a new convention, tool, skill, or command.
|
||||
**Command:** `/add-ecc-bundle-component`
|
||||
|
||||
### Prefixes Used
|
||||
1. **Identify** the type of component to add (tool, skill, identity, command).
|
||||
2. **Create or update** the relevant file in the appropriate directory:
|
||||
- Tools: `.claude/ecc-tools.json`
|
||||
- Skills: `.claude/skills/everything-claude-code/SKILL.md` or `.agents/skills/everything-claude-code/SKILL.md`
|
||||
- Identity: `.claude/identity.json`
|
||||
- Commands: `.claude/commands/*.md`
|
||||
3. **Commit** the changes with a message indicating the addition to the ECC bundle.
|
||||
- Example: `feat: add new skill to ECC bundle`
|
||||
4. **Push** your changes and open a pull request if required.
|
||||
|
||||
- `feat`
|
||||
|
||||
### Message Guidelines
|
||||
|
||||
- Average message length: ~94 characters
|
||||
- Keep first line concise and descriptive
|
||||
- Use imperative mood ("Add feature" not "Added feature")
|
||||
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code-conventions ECC bundle (.claude/ecc-tools.json)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code-conventions ECC bundle (.claude/identity.json)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code-conventions ECC bundle (.codex/agents/explorer.toml)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code-conventions ECC bundle (.codex/agents/reviewer.toml)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code-conventions ECC bundle (.codex/agents/docs-researcher.toml)
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat: add everything-claude-code-conventions 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-conventions ECC bundle (.claude/ecc-tools.json)
|
||||
feat: add everything-claude-code-conventions ECC bundle (.claude/skills/everything-claude-code/SKILL.md)
|
||||
feat: add everything-claude-code-conventions ECC bundle (.agents/skills/everything-claude-code/SKILL.md)
|
||||
```
|
||||
|
||||
### Add Ecc Bundle Component
|
||||
|
||||
Adds a new component to the everything-claude-code-conventions ECC bundle, such as a tool definition, skill file, identity, or command documentation.
|
||||
|
||||
**Frequency**: ~5 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or update a file under a relevant ECC bundle directory (e.g., .claude/ecc-tools.json, .claude/skills/everything-claude-code/SKILL.md, .agents/skills/everything-claude-code/SKILL.md, .claude/identity.json, .claude/commands/*.md)
|
||||
2. Commit the file with a message indicating addition to the ECC bundle
|
||||
|
||||
**Files typically involved**:
|
||||
**Files Involved:**
|
||||
- `.claude/ecc-tools.json`
|
||||
- `.claude/skills/everything-claude-code/SKILL.md`
|
||||
- `.agents/skills/everything-claude-code/SKILL.md`
|
||||
@@ -167,28 +57,38 @@ Adds a new component to the everything-claude-code-conventions ECC bundle, such
|
||||
- `.claude/commands/feature-development.md`
|
||||
- `.claude/commands/add-ecc-bundle-component.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or update a file under a relevant ECC bundle directory (e.g., .claude/ecc-tools.json, .claude/skills/everything-claude-code/SKILL.md, .agents/skills/everything-claude-code/SKILL.md, .claude/identity.json, .claude/commands/*.md)
|
||||
Commit the file with a message indicating addition to the ECC bundle
|
||||
#### Example: Adding a New Skill
|
||||
|
||||
1. Create a new skill file: `.claude/skills/everything-claude-code/myNewSkill.md`
|
||||
2. Add documentation and usage details.
|
||||
3. Commit:
|
||||
```
|
||||
feat: add myNewSkill to ECC bundle
|
||||
```
|
||||
4. Push and submit for review.
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
- **Test files** use the pattern: `*.test.*`
|
||||
- Example: `userProfile.test.ts`
|
||||
- **Testing framework** is not explicitly defined; follow the existing test file structure.
|
||||
- Place tests alongside the modules they test or in a dedicated `tests/` directory if present.
|
||||
|
||||
```typescript
|
||||
// Example test file: userProfile.test.ts
|
||||
import { getUserProfile } from './userProfile';
|
||||
|
||||
describe('getUserProfile', () => {
|
||||
it('returns correct profile data', () => {
|
||||
// test implementation
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
## Best Practices
|
||||
| Command | Purpose |
|
||||
|----------------------------|-----------------------------------------------------------------|
|
||||
| /add-ecc-bundle-component | Add a new tool, skill, identity, or command to the ECC bundle |
|
||||
|
||||
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