Everything Claude Code Conventions

1---
2name: everything-claude-code-conventions
3description: Development conventions and patterns for everything-claude-code. JavaScript project with conventional commits.
4---
5 
6# Everything Claude Code Conventions
7 
8> Generated from [affaan-m/everything-claude-code](https://github.com/affaan-m/everything-claude-code) on 2026-03-20
9 
10## Overview
11 
12This skill teaches Claude the development patterns and conventions used in everything-claude-code.
13 
14## Tech Stack
15 
16- **Primary Language**: JavaScript
17- **Architecture**: hybrid module organization
18- **Test Location**: separate
19 
20## When to Use This Skill
21 
22Activate this skill when:
23- Making changes to this repository
24- Adding new features following established patterns
25- Writing tests that match project conventions
26- Creating commits with proper message format
27 
28## Commit Conventions
29 
30Follow these commit message conventions based on 500 analyzed commits.
31 
32### Commit Style: Conventional Commits
33 
34### Prefixes Used
35 
36- `fix`
37- `test`
38- `feat`
39- `docs`
40 
41### Message Guidelines
42 
43- Average message length: ~65 characters
44- Keep first line concise and descriptive
45- Use imperative mood ("Add feature" not "Added feature")
46 
47 
48*Commit message example*
49 
50```text
51feat(rules): add C# language support
52```
53 
54*Commit message example*
55 
56```text
57chore(deps-dev): bump flatted (#675)
58```
59 
60*Commit message example*
61 
62```text
63fix: auto-detect ECC root from plugin cache when CLAUDE_PLUGIN_ROOT is unset (#547) (#691)
64```
65 
66*Commit message example*
67 
68```text
69docs: add Antigravity setup and usage guide (#552)
70```
71 
72*Commit message example*
73 
74```text
75merge: PR #529 — feat(skills): add documentation-lookup, bun-runtime, nextjs-turbopack; feat(agents): add rust-reviewer
76```
77 
78*Commit message example*
79 
80```text
81Revert "Add Kiro IDE support (.kiro/) (#548)"
82```
83 
84*Commit message example*
85 
86```text
87Add Kiro IDE support (.kiro/) (#548)
88```
89 
90*Commit message example*
91 
92```text
93feat: add block-no-verify hook for Claude Code and Cursor (#649)
94```
95 
96## Architecture
97 
98### Project Structure: Single Package
99 
100This project uses **hybrid** module organization.
101 
102### Configuration Files
103 
104- `.github/workflows/ci.yml`
105- `.github/workflows/maintenance.yml`
106- `.github/workflows/monthly-metrics.yml`
107- `.github/workflows/release.yml`
108- `.github/workflows/reusable-release.yml`
109- `.github/workflows/reusable-test.yml`
110- `.github/workflows/reusable-validate.yml`
111- `.opencode/package.json`
112- `.opencode/tsconfig.json`
113- `.prettierrc`
114- `eslint.config.js`
115- `package.json`
116 
117### Guidelines
118 
119- This project uses a hybrid organization
120- Follow existing patterns when adding new code
121 
122## Code Style
123 
124### Language: JavaScript
125 
126### Naming Conventions
127 
128| Element | Convention |
129|---------|------------|
130| Files | camelCase |
131| Functions | camelCase |
132| Classes | PascalCase |
133| Constants | SCREAMING_SNAKE_CASE |
134 
135### Import Style: Relative Imports
136 
137### Export Style: Mixed Style
138 
139 
140*Preferred import style*
141 
142```typescript
143// Use relative imports
144import { Button } from '../components/Button'
145import { useAuth } from './hooks/useAuth'
146```
147 
148## Testing
149 
150### Test Framework
151 
152No specific test framework detected — use the repository's existing test patterns.
153 
154### File Pattern: `*.test.js`
155 
156### Test Types
157 
158- **Unit tests**: Test individual functions and components in isolation
159- **Integration tests**: Test interactions between multiple components/services
160 
161### Coverage
162 
163This project has coverage reporting configured. Aim for 80%+ coverage.
164 
165 
166## Error Handling
167 
168### Error Handling Style: Try-Catch Blocks
169 
170 
171*Standard error handling pattern*
172 
173```typescript
174try {
175  const result = await riskyOperation()
176  return result
177} catch (error) {
178  console.error('Operation failed:', error)
179  throw new Error('User-friendly message')
180}
181```
182 
183## Common Workflows
184 
185These workflows were detected from analyzing commit patterns.
186 
187### Database Migration
188 
189Database schema changes with migration files
190 
191**Frequency**: ~2 times per month
192 
193**Steps**:
1941. Create migration file
1952. Update schema definitions
1963. Generate/update types
197 
198**Files typically involved**:
199- `**/schema.*`
200- `migrations/*`
201 
202**Example commit sequence**:
203```
204feat: implement --with/--without selective install flags (#679)
205fix: sync catalog counts with filesystem (27 agents, 113 skills, 58 commands) (#693)
206feat(rules): add Rust language rules (rebased #660) (#686)
207```
208 
209### Feature Development
210 
211Standard feature implementation workflow
212 
213**Frequency**: ~22 times per month
214 
215**Steps**:
2161. Add feature implementation
2172. Add tests for feature
2183. Update documentation
219 
220**Files typically involved**:
221- `manifests/*`
222- `schemas/*`
223- `**/*.test.*`
224- `**/api/**`
225 
226**Example commit sequence**:
227```
228feat(skills): add documentation-lookup, bun-runtime, nextjs-turbopack; feat(agents): add rust-reviewer
229docs(skills): align documentation-lookup with CONTRIBUTING template; add cross-harness (Codex/Cursor) skill copies
230fix: 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
231```
232 
233### Add Language Rules
234 
235Adds a new programming language to the rules system, including coding style, hooks, patterns, security, and testing guidelines.
236 
237**Frequency**: ~2 times per month
238 
239**Steps**:
2401. Create a new directory under rules/{language}/
2412. Add coding-style.md, hooks.md, patterns.md, security.md, and testing.md files with language-specific content
2423. Optionally reference or link to related skills
243 
244**Files typically involved**:
245- `rules/*/coding-style.md`
246- `rules/*/hooks.md`
247- `rules/*/patterns.md`
248- `rules/*/security.md`
249- `rules/*/testing.md`
250 
251**Example commit sequence**:
252```
253Create a new directory under rules/{language}/
254Add coding-style.md, hooks.md, patterns.md, security.md, and testing.md files with language-specific content
255Optionally reference or link to related skills
256```
257 
258### Add New Skill
259 
260Adds a new skill to the system, documenting its workflow, triggers, and usage, often with supporting scripts.
261 
262**Frequency**: ~4 times per month
263 
264**Steps**:
2651. Create a new directory under skills/{skill-name}/
2662. Add SKILL.md with documentation (When to Use, How It Works, Examples, etc.)
2673. Optionally add scripts or supporting files under skills/{skill-name}/scripts/
2684. Address review feedback and iterate on documentation
269 
270**Files typically involved**:
271- `skills/*/SKILL.md`
272- `skills/*/scripts/*.sh`
273- `skills/*/scripts/*.js`
274 
275**Example commit sequence**:
276```
277Create a new directory under skills/{skill-name}/
278Add SKILL.md with documentation (When to Use, How It Works, Examples, etc.)
279Optionally add scripts or supporting files under skills/{skill-name}/scripts/
280Address review feedback and iterate on documentation
281```
282 
283### Add New Agent
284 
285Adds a new agent to the system for code review, build resolution, or other automated tasks.
286 
287**Frequency**: ~2 times per month
288 
289**Steps**:
2901. Create a new agent markdown file under agents/{agent-name}.md
2912. Register the agent in AGENTS.md
2923. Optionally update README.md and docs/COMMAND-AGENT-MAP.md
293 
294**Files typically involved**:
295- `agents/*.md`
296- `AGENTS.md`
297- `README.md`
298- `docs/COMMAND-AGENT-MAP.md`
299 
300**Example commit sequence**:
301```
302Create a new agent markdown file under agents/{agent-name}.md
303Register the agent in AGENTS.md
304Optionally update README.md and docs/COMMAND-AGENT-MAP.md
305```
306 
307### Add New Command
308 
309Adds a new command to the system, often paired with a backing skill.
310 
311**Frequency**: ~1 times per month
312 
313**Steps**:
3141. Create a new markdown file under commands/{command-name}.md
3152. Optionally add or update a backing skill under skills/{skill-name}/SKILL.md
316 
317**Files typically involved**:
318- `commands/*.md`
319- `skills/*/SKILL.md`
320 
321**Example commit sequence**:
322```
323Create a new markdown file under commands/{command-name}.md
324Optionally add or update a backing skill under skills/{skill-name}/SKILL.md
325```
326 
327### Sync Catalog Counts
328 
329Synchronizes the documented counts of agents, skills, and commands in AGENTS.md and README.md with the actual repository state.
330 
331**Frequency**: ~3 times per month
332 
333**Steps**:
3341. Update agent, skill, and command counts in AGENTS.md
3352. Update the same counts in README.md (quick-start, comparison table, etc.)
3363. Optionally update other documentation files
337 
338**Files typically involved**:
339- `AGENTS.md`
340- `README.md`
341 
342**Example commit sequence**:
343```
344Update agent, skill, and command counts in AGENTS.md
345Update the same counts in README.md (quick-start, comparison table, etc.)
346Optionally update other documentation files
347```
348 
349### Add Cross Harness Skill Copies
350 
351Adds skill copies for different agent harnesses (e.g., Codex, Cursor, Antigravity) to ensure compatibility across platforms.
352 
353**Frequency**: ~2 times per month
354 
355**Steps**:
3561. Copy or adapt SKILL.md to .agents/skills/{skill}/SKILL.md and/or .cursor/skills/{skill}/SKILL.md
3572. Optionally add harness-specific openai.yaml or config files
3583. Address review feedback to align with CONTRIBUTING template
359 
360**Files typically involved**:
361- `.agents/skills/*/SKILL.md`
362- `.cursor/skills/*/SKILL.md`
363- `.agents/skills/*/agents/openai.yaml`
364 
365**Example commit sequence**:
366```
367Copy or adapt SKILL.md to .agents/skills/{skill}/SKILL.md and/or .cursor/skills/{skill}/SKILL.md
368Optionally add harness-specific openai.yaml or config files
369Address review feedback to align with CONTRIBUTING template
370```
371 
372### Add Or Update Hook
373 
374Adds or updates git or bash hooks to enforce workflow, quality, or security policies.
375 
376**Frequency**: ~1 times per month
377 
378**Steps**:
3791. Add or update hook scripts in hooks/ or scripts/hooks/
3802. Register the hook in hooks/hooks.json or similar config
3813. Optionally add or update tests in tests/hooks/
382 
383**Files typically involved**:
384- `hooks/*.hook`
385- `hooks/hooks.json`
386- `scripts/hooks/*.js`
387- `tests/hooks/*.test.js`
388- `.cursor/hooks.json`
389 
390**Example commit sequence**:
391```
392Add or update hook scripts in hooks/ or scripts/hooks/
393Register the hook in hooks/hooks.json or similar config
394Optionally add or update tests in tests/hooks/
395```
396 
397### Address Review Feedback
398 
399Addresses code review feedback by updating documentation, scripts, or configuration for clarity, correctness, or convention alignment.
400 
401**Frequency**: ~4 times per month
402 
403**Steps**:
4041. Edit SKILL.md, agent, or command files to address reviewer comments
4052. Update examples, headings, or configuration as requested
4063. Iterate until all review feedback is resolved
407 
408**Files typically involved**:
409- `skills/*/SKILL.md`
410- `agents/*.md`
411- `commands/*.md`
412- `.agents/skills/*/SKILL.md`
413- `.cursor/skills/*/SKILL.md`
414 
415**Example commit sequence**:
416```
417Edit SKILL.md, agent, or command files to address reviewer comments
418Update examples, headings, or configuration as requested
419Iterate until all review feedback is resolved
420```
421 
422 
423## Best Practices
424 
425Based on analysis of the codebase, follow these practices:
426 
427### Do
428 
429- Use conventional commit format (feat:, fix:, etc.)
430- Follow *.test.js naming pattern
431- Use camelCase for file names
432- Prefer mixed exports
433 
434### Don't
435 
436- Don't write vague commit messages
437- Don't skip tests for new features
438- Don't deviate from established patterns without discussion
439 
440---
441 
442*This skill was auto-generated by [ECC Tools](https://ecc.tools). Review and customize as needed for your team.*
443