zsp/everything-claude-code
1
0
Fork 0
mirror of https://github.com/affaan-m/everything-claude-code.git synced 2026-04-06 09:13:31 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: add everything-claude-code-conventions ECC bundle (.claude/skills/everything-claude-code/SKILL.md)

Browse Source
This commit is contained in:
ecc-tools[bot]
2026-04-04 06:24:08 +00:00
committed by GitHub
parent 3208a0b88e
commit 2a80e98e84
1 changed files with 43 additions and 275 deletions
Download Patch File Download Diff File Expand all files Collapse all files

318
.claude/skills/everything-claude-code/SKILL.md
View File

@@ -1,11 +1,11 @@
--- ---
name: everything-claude-code-conventions name: everything-claude-code-conventions
description: Development conventions and patterns for everything-claude-code. JavaScript project with conventional commits. description: Development conventions and patterns for everything-claude-code. TypeScript project with conventional commits.
--- ---
# Everything Claude Code Conventions # Everything Claude Code Conventions
> Generated from [affaan-m/everything-claude-code](https://github.com/affaan-m/everything-claude-code) on 2026-03-20 > Generated from [affaan-m/everything-claude-code](https://github.com/affaan-m/everything-claude-code) on 2026-04-04
## Overview ## Overview
@@ -13,7 +13,7 @@ This skill teaches Claude the development patterns and conventions used in every
## Tech Stack ## Tech Stack
- **Primary Language**: JavaScript - **Primary Language**: TypeScript
- **Architecture**: hybrid module organization - **Architecture**: hybrid module organization
- **Test Location**: separate - **Test Location**: separate
@@ -27,20 +27,17 @@ Activate this skill when:
## Commit Conventions ## Commit Conventions
Follow these commit message conventions based on 500 analyzed commits. Follow these commit message conventions based on 10 analyzed commits.
### Commit Style: Conventional Commits ### Commit Style: Conventional Commits
### Prefixes Used ### Prefixes Used
- `fix`
- `test`
- `feat` - `feat`
- `docs`
### Message Guidelines ### Message Guidelines
- Average message length: ~65 characters - Average message length: ~82 characters
- Keep first line concise and descriptive - Keep first line concise and descriptive
- Use imperative mood ("Add feature" not "Added feature") - Use imperative mood ("Add feature" not "Added feature")
@@ -48,49 +45,49 @@ Follow these commit message conventions based on 500 analyzed commits.
*Commit message example* *Commit message example*
```text ```text
feat(rules): add C# language support feat: add everything-claude-code ECC bundle (.claude/ecc-tools.json)
``` ```
*Commit message example* *Commit message example*
```text ```text
chore(deps-dev): bump flatted (#675) feat: add everything-claude-code ECC bundle (.claude/skills/everything-claude-code/SKILL.md)
``` ```
*Commit message example* *Commit message example*
```text ```text
fix: auto-detect ECC root from plugin cache when CLAUDE_PLUGIN_ROOT is unset (#547) (#691) feat: add everything-claude-code ECC bundle (.agents/skills/everything-claude-code/SKILL.md)
``` ```
*Commit message example* *Commit message example*
```text ```text
docs: add Antigravity setup and usage guide (#552) feat: add everything-claude-code ECC bundle (.claude/identity.json)
``` ```
*Commit message example* *Commit message example*
```text ```text
merge: PR #529 — feat(skills): add documentation-lookup, bun-runtime, nextjs-turbopack; feat(agents): add rust-reviewer feat: add everything-claude-code ECC bundle (.codex/agents/explorer.toml)
``` ```
*Commit message example* *Commit message example*
```text ```text
Revert "Add Kiro IDE support (.kiro/) (#548)" feat: add everything-claude-code ECC bundle (.codex/agents/reviewer.toml)
``` ```
*Commit message example* *Commit message example*
```text ```text
Add Kiro IDE support (.kiro/) (#548) feat: add everything-claude-code ECC bundle (.codex/agents/docs-researcher.toml)
``` ```
*Commit message example* *Commit message example*
```text ```text
feat: add block-no-verify hook for Claude Code and Cursor (#649) feat: add everything-claude-code ECC bundle (.claude/commands/feature-development.md)
``` ```
## Architecture ## Architecture
@@ -99,21 +96,6 @@ feat: add block-no-verify hook for Claude Code and Cursor (#649)
This project uses **hybrid** module organization. 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 ### Guidelines
- This project uses a hybrid organization - This project uses a hybrid organization
@@ -121,7 +103,7 @@ This project uses **hybrid** module organization.
## Code Style ## Code Style
### Language: JavaScript ### Language: TypeScript
### Naming Conventions ### Naming Conventions
@@ -134,7 +116,7 @@ This project uses **hybrid** module organization.
### Import Style: Relative Imports ### Import Style: Relative Imports
### Export Style: Mixed Style ### Export Style: Named Exports
*Preferred import style* *Preferred import style*
@@ -145,72 +127,24 @@ import { Button } from '../components/Button'
import { useAuth } from './hooks/useAuth' import { useAuth } from './hooks/useAuth'
``` ```
## Testing *Preferred export style*
### 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 ```typescript
try { // Use named exports
const result = await riskyOperation() export function calculateTotal() { ... }
return result export const TAX_RATE = 0.1
} catch (error) { export interface Order { ... }
console.error('Operation failed:', error)
throw new Error('User-friendly message')
}
``` ```
## Common Workflows ## Common Workflows
These workflows were detected from analyzing commit patterns. These workflows were detected from analyzing commit patterns.
### Database Migration
Database schema changes with migration files
**Frequency**: ~2 times per month
**Steps**:
1. Create migration file
2. Update schema definitions
3. Generate/update types
**Files typically involved**:
- `**/schema.*`
- `migrations/*`
**Example commit sequence**:
```
feat: implement --with/--without selective install flags (#679)
fix: sync catalog counts with filesystem (27 agents, 113 skills, 58 commands) (#693)
feat(rules): add Rust language rules (rebased #660) (#686)
```
### Feature Development ### Feature Development
Standard feature implementation workflow Standard feature implementation workflow
**Frequency**: ~22 times per month **Frequency**: ~30 times per month
**Steps**: **Steps**:
1. Add feature implementation 1. Add feature implementation
@@ -218,205 +152,41 @@ Standard feature implementation workflow
3. Update documentation 3. Update documentation
**Files typically involved**: **Files typically involved**:
- `manifests/*` - `.claude/commands/*`
- `schemas/*`
- `**/*.test.*`
- `**/api/**`
**Example commit sequence**: **Example commit sequence**:
``` ```
feat(skills): add documentation-lookup, bun-runtime, nextjs-turbopack; feat(agents): add rust-reviewer feat: add everything-claude-code ECC bundle (.claude/ecc-tools.json)
docs(skills): align documentation-lookup with CONTRIBUTING template; add cross-harness (Codex/Cursor) skill copies feat: add everything-claude-code ECC bundle (.claude/skills/everything-claude-code/SKILL.md)
fix: address PR review — skill template (When to use, How it works, Examples), bun.lock, next build note, rust-reviewer CI note, doc-lookup privacy/uncertainty feat: add everything-claude-code ECC bundle (.agents/skills/everything-claude-code/SKILL.md)
``` ```
### Add Language Rules ### Add Ecc Bundle Component
Adds a new programming language to the rules system, including coding style, hooks, patterns, security, and testing guidelines. 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**: ~2 times per month **Frequency**: ~10 times per month
**Steps**: **Steps**:
1. Create a new directory under rules/{language}/ 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. Add coding-style.md, hooks.md, patterns.md, security.md, and testing.md files with language-specific content 2. Commit the new or updated file with a descriptive message referencing the ECC bundle
3. Optionally reference or link to related skills
**Files typically involved**: **Files typically involved**:
- `rules/*/coding-style.md` - `.claude/ecc-tools.json`
- `rules/*/hooks.md` - `.claude/skills/everything-claude-code/SKILL.md`
- `rules/*/patterns.md` - `.agents/skills/everything-claude-code/SKILL.md`
- `rules/*/security.md` - `.agents/skills/everything-claude-code/agents/openai.yaml`
- `rules/*/testing.md` - `.claude/identity.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`
**Example commit sequence**: **Example commit sequence**:
``` ```
Create a new directory under rules/{language}/ 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)
Add coding-style.md, hooks.md, patterns.md, security.md, and testing.md files with language-specific content Commit the new or updated file with a descriptive message referencing the ECC bundle
Optionally reference or link to related skills
```
### Add New Skill
Adds a new skill to the system, documenting its workflow, triggers, and usage, often with supporting scripts.
**Frequency**: ~4 times per month
**Steps**:
1. Create a new directory under skills/{skill-name}/
2. Add SKILL.md with documentation (When to Use, How It Works, Examples, etc.)
3. Optionally add scripts or supporting files under skills/{skill-name}/scripts/
4. Address review feedback and iterate on documentation
**Files typically involved**:
- `skills/*/SKILL.md`
- `skills/*/scripts/*.sh`
- `skills/*/scripts/*.js`
**Example commit sequence**:
```
Create a new directory under skills/{skill-name}/
Add SKILL.md with documentation (When to Use, How It Works, Examples, etc.)
Optionally add scripts or supporting files under skills/{skill-name}/scripts/
Address review feedback and iterate on documentation
```
### Add New Agent
Adds a new agent to the system for code review, build resolution, or other automated tasks.
**Frequency**: ~2 times per month
**Steps**:
1. Create a new agent markdown file under agents/{agent-name}.md
2. Register the agent in AGENTS.md
3. Optionally update README.md and docs/COMMAND-AGENT-MAP.md
**Files typically involved**:
- `agents/*.md`
- `AGENTS.md`
- `README.md`
- `docs/COMMAND-AGENT-MAP.md`
**Example commit sequence**:
```
Create a new agent markdown file under agents/{agent-name}.md
Register the agent in AGENTS.md
Optionally update README.md and docs/COMMAND-AGENT-MAP.md
```
### Add New Command
Adds a new command to the system, often paired with a backing skill.
**Frequency**: ~1 times per month
**Steps**:
1. Create a new markdown file under commands/{command-name}.md
2. Optionally add or update a backing skill under skills/{skill-name}/SKILL.md
**Files typically involved**:
- `commands/*.md`
- `skills/*/SKILL.md`
**Example commit sequence**:
```
Create a new markdown file under commands/{command-name}.md
Optionally add or update a backing skill under skills/{skill-name}/SKILL.md
```
### Sync Catalog Counts
Synchronizes the documented counts of agents, skills, and commands in AGENTS.md and README.md with the actual repository state.
**Frequency**: ~3 times per month
**Steps**:
1. Update agent, skill, and command counts in AGENTS.md
2. Update the same counts in README.md (quick-start, comparison table, etc.)
3. Optionally update other documentation files
**Files typically involved**:
- `AGENTS.md`
- `README.md`
**Example commit sequence**:
```
Update agent, skill, and command counts in AGENTS.md
Update the same counts in README.md (quick-start, comparison table, etc.)
Optionally update other documentation files
```
### Add Cross Harness Skill Copies
Adds skill copies for different agent harnesses (e.g., Codex, Cursor, Antigravity) to ensure compatibility across platforms.
**Frequency**: ~2 times per month
**Steps**:
1. Copy or adapt SKILL.md to .agents/skills/{skill}/SKILL.md and/or .cursor/skills/{skill}/SKILL.md
2. Optionally add harness-specific openai.yaml or config files
3. Address review feedback to align with CONTRIBUTING template
**Files typically involved**:
- `.agents/skills/*/SKILL.md`
- `.cursor/skills/*/SKILL.md`
- `.agents/skills/*/agents/openai.yaml`
**Example commit sequence**:
```
Copy or adapt SKILL.md to .agents/skills/{skill}/SKILL.md and/or .cursor/skills/{skill}/SKILL.md
Optionally add harness-specific openai.yaml or config files
Address review feedback to align with CONTRIBUTING template
```
### Add Or Update Hook
Adds or updates git or bash hooks to enforce workflow, quality, or security policies.
**Frequency**: ~1 times per month
**Steps**:
1. Add or update hook scripts in hooks/ or scripts/hooks/
2. Register the hook in hooks/hooks.json or similar config
3. Optionally add or update tests in tests/hooks/
**Files typically involved**:
- `hooks/*.hook`
- `hooks/hooks.json`
- `scripts/hooks/*.js`
- `tests/hooks/*.test.js`
- `.cursor/hooks.json`
**Example commit sequence**:
```
Add or update hook scripts in hooks/ or scripts/hooks/
Register the hook in hooks/hooks.json or similar config
Optionally add or update tests in tests/hooks/
```
### Address Review Feedback
Addresses code review feedback by updating documentation, scripts, or configuration for clarity, correctness, or convention alignment.
**Frequency**: ~4 times per month
**Steps**:
1. Edit SKILL.md, agent, or command files to address reviewer comments
2. Update examples, headings, or configuration as requested
3. Iterate until all review feedback is resolved
**Files typically involved**:
- `skills/*/SKILL.md`
- `agents/*.md`
- `commands/*.md`
- `.agents/skills/*/SKILL.md`
- `.cursor/skills/*/SKILL.md`
**Example commit sequence**:
```
Edit SKILL.md, agent, or command files to address reviewer comments
Update examples, headings, or configuration as requested
Iterate until all review feedback is resolved
``` ```
@@ -427,14 +197,12 @@ Based on analysis of the codebase, follow these practices:
### Do ### Do
- Use conventional commit format (feat:, fix:, etc.) - Use conventional commit format (feat:, fix:, etc.)
- Follow *.test.js naming pattern
- Use camelCase for file names - Use camelCase for file names
- Prefer mixed exports - Prefer named exports
### Don't ### Don't
- Don't write vague commit messages - Don't write vague commit messages
- Don't skip tests for new features
- Don't deviate from established patterns without discussion - Don't deviate from established patterns without discussion
--- ---