mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-04-04 08:13:30 +08:00
Compare commits
10 Commits
ecc-tools/
...
ecc-tools/
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8b41458b77 | ||
|
|
4dbdd45d45 | ||
|
|
afbb9d8745 | ||
|
|
bc3bbf7e83 | ||
|
|
307cc357db | ||
|
|
5f6f658dad | ||
|
|
9752af14e3 | ||
|
|
6445abc20c | ||
|
|
bd3fedc393 | ||
|
|
6cfcad0bea |
@@ -1,93 +1,204 @@
|
||||
```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-03
|
||||
|
||||
## Overview
|
||||
This skill documents the core development patterns and conventions used in the `everything-claude-code` TypeScript repository. It covers file naming, import/export styles, commit conventions, and the primary workflow for extending the ECC bundle with new skills, identities, or commands. Use this guide to ensure consistency and best practices when contributing to the codebase.
|
||||
|
||||
## 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 within the repository.
|
||||
- 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** standard.
|
||||
- Use the `feat` prefix for new features.
|
||||
- Example:
|
||||
```
|
||||
feat: add user authentication to api layer
|
||||
```
|
||||
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 add a new skill, identity, or command to the ECC bundle.
|
||||
**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 following directories:
|
||||
- `.claude/skills/everything-claude-code/`
|
||||
- `.agents/skills/everything-claude-code/`
|
||||
- `.claude/commands/`
|
||||
- `.claude/identity.json`
|
||||
2. **Write or update** the content for your new skill, identity, or command.
|
||||
3. **Commit** your changes with a message referencing the ECC bundle, following the conventional commit pattern.
|
||||
- Example:
|
||||
```
|
||||
feat: add SKILL.md for everything-claude-code ECC bundle
|
||||
```
|
||||
4. **Push** your changes and open a pull request if required.
|
||||
### Commit Style: Conventional Commits
|
||||
|
||||
#### Example: Adding a New Skill
|
||||
```bash
|
||||
# Create a new skill file
|
||||
touch .claude/skills/everything-claude-code/newSkill.md
|
||||
### Prefixes Used
|
||||
|
||||
# Edit the file with your skill documentation
|
||||
- `feat`
|
||||
|
||||
# Commit your changes
|
||||
git add .claude/skills/everything-claude-code/newSkill.md
|
||||
git commit -m "feat: add newSkill to ECC bundle"
|
||||
git push
|
||||
### 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)
|
||||
```
|
||||
|
||||
## Testing Patterns
|
||||
*Commit message example*
|
||||
|
||||
- **Test files** use the pattern `*.test.*` (e.g., `userProfile.test.ts`).
|
||||
- **Testing framework** is not explicitly specified; follow standard TypeScript testing practices.
|
||||
- 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('returns 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 skill, identity, or command to the ECC bundle |
|
||||
```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 skills, agent configs, or commands.
|
||||
|
||||
**Frequency**: ~4 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or update a file under a relevant ECC bundle directory (e.g., .claude/skills/everything-claude-code/, .agents/skills/everything-claude-code/, .claude/commands/)
|
||||
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/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/skills/everything-claude-code/, .agents/skills/everything-claude-code/, .claude/commands/)
|
||||
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,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 skill, identity, or command file.
|
||||
Adds a new component to the everything-claude-code ECC bundle, such as skills, agent configs, or commands.
|
||||
|
||||
## Common Files
|
||||
|
||||
@@ -18,7 +18,6 @@ Adds a new component to the everything-claude-code-conventions ECC bundle, such
|
||||
- `.agents/skills/everything-claude-code/SKILL.md`
|
||||
- `.claude/commands/feature-development.md`
|
||||
- `.claude/commands/add-ecc-bundle-component.md`
|
||||
- `.claude/identity.json`
|
||||
|
||||
## Suggested Sequence
|
||||
|
||||
@@ -29,7 +28,7 @@ Adds a new component to the everything-claude-code-conventions ECC bundle, such
|
||||
|
||||
## Typical Commit Signals
|
||||
|
||||
- Create or update a file under .claude/skills/everything-claude-code/ or .agents/skills/everything-claude-code/ or .claude/commands/ or .claude/identity.json
|
||||
- Create or update a file under a relevant ECC bundle directory (e.g., .claude/skills/everything-claude-code/, .agents/skills/everything-claude-code/, .claude/commands/)
|
||||
- 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-03T22:06:30.526Z",
|
||||
"generatedAt": "2026-04-03T19:04:33.110Z",
|
||||
"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-03T22:06:46.898Z"
|
||||
"createdAt": "2026-04-03T22:06:03.806Z"
|
||||
}
|
||||
@@ -1,93 +1,204 @@
|
||||
```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-03
|
||||
|
||||
## Overview
|
||||
This skill documents the core development patterns and conventions used in the `everything-claude-code` TypeScript repository. It covers file naming, import/export styles, commit conventions, and the primary workflow for extending the ECC bundle with new skills, identities, or commands. Use this guide to ensure consistency and best practices when contributing to the codebase.
|
||||
|
||||
## 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 within the repository.
|
||||
- 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** standard.
|
||||
- Use the `feat` prefix for new features.
|
||||
- Example:
|
||||
```
|
||||
feat: add user authentication to api layer
|
||||
```
|
||||
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 add a new skill, identity, or command to the ECC bundle.
|
||||
**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 following directories:
|
||||
- `.claude/skills/everything-claude-code/`
|
||||
- `.agents/skills/everything-claude-code/`
|
||||
- `.claude/commands/`
|
||||
- `.claude/identity.json`
|
||||
2. **Write or update** the content for your new skill, identity, or command.
|
||||
3. **Commit** your changes with a message referencing the ECC bundle, following the conventional commit pattern.
|
||||
- Example:
|
||||
```
|
||||
feat: add SKILL.md for everything-claude-code ECC bundle
|
||||
```
|
||||
4. **Push** your changes and open a pull request if required.
|
||||
### Commit Style: Conventional Commits
|
||||
|
||||
#### Example: Adding a New Skill
|
||||
```bash
|
||||
# Create a new skill file
|
||||
touch .claude/skills/everything-claude-code/newSkill.md
|
||||
### Prefixes Used
|
||||
|
||||
# Edit the file with your skill documentation
|
||||
- `feat`
|
||||
|
||||
# Commit your changes
|
||||
git add .claude/skills/everything-claude-code/newSkill.md
|
||||
git commit -m "feat: add newSkill to ECC bundle"
|
||||
git push
|
||||
### 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)
|
||||
```
|
||||
|
||||
## Testing Patterns
|
||||
*Commit message example*
|
||||
|
||||
- **Test files** use the pattern `*.test.*` (e.g., `userProfile.test.ts`).
|
||||
- **Testing framework** is not explicitly specified; follow standard TypeScript testing practices.
|
||||
- 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('returns 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 skill, identity, or command to the ECC bundle |
|
||||
```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 skills, agent configs, or commands.
|
||||
|
||||
**Frequency**: ~4 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or update a file under a relevant ECC bundle directory (e.g., .claude/skills/everything-claude-code/, .agents/skills/everything-claude-code/, .claude/commands/)
|
||||
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/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/skills/everything-claude-code/, .agents/skills/everything-claude-code/, .claude/commands/)
|
||||
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